Skip to content

B6 - first release #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 23, 2025
Merged

Conversation

jameshnl232
Copy link
Contributor

Opening a Pull Request to Update your Project

I've started a documentation on how we should use the forking workflow here:

https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md
(will not be merged to main due to file sizes)

Please follow these Steps & Guidelines for your Pull Request:

First, Check and Tick these Boxes:

[x] make sure that the hugo site build works and check the result visually.
[x] merge your local branch with upstream/main (see update doc)
[] Deploy the Site on your github pages by activating the "Deploy Page using GH-Actions" Workflow in "gh-pages-action.yml"
[x] make sure that your PR contains only files / file changes within your project subdirectory.
[x] make sure that all your file names consist only of lower case letters, numbers, or [-_.] - with only one . for the file extension
[x] delete all unnecessary files from your PR (including cat.jpg and kitty.jpg)
[x] check the image file sizes. All Images have to be as small as possible. See ./doc/disk_usage.md about this issues, there's a script: ./bin/images-smaller.sh

Note that if you fail to do so, I may simply reduce the file sizes brute force using
the script above - WITHOUT CHECKING THE QUALITY

Fill out this Information:

  1. Change the PR Title to: (e.g. B0 - update techstack.md) and describe your changes:

  2. URL of your Preview Site Containing the Changes:

  3. When did your Project Supervisor review your changes? (Date/Note or require review for PR):

  4. If your disk usage exceeds 500K, provide a reason while you want to include so many images or why certain images need to be that big:

IMPORTANT: if you run into trouble / If the checks fail...

  • if you cannot figure out why a check fails or you think that it may be wrong,
    don't hesitate to contact me! (e.g. by requesting a review and commenting in the pr)

  • run the checks locally with:

    ./bin/check-project-update-pr/run-all.sh <project_id>

All good?

If all checks run successfully the PR will be reviewed and, if no
further changes are requested, merged and closed.
(this is the time to update and start a new branch!)

More Information

We are using the Forking Workflow.

@jameshnl232 jameshnl232 changed the title B6-Elara_Health first draft B6 - first draft Jan 21, 2025
@jameshnl232 jameshnl232 reopened this Jan 21, 2025
@jameshnl232
Copy link
Contributor Author

In the second commit, I changed the file name to lowercase. Can you check if you could approve that so the test can be passed? Thank you and let me know if there is something wrong!

@bkleinen
Copy link
Contributor

In the second commit, I changed the file name to lowercase. Can you check if you could approve that so the test can be passed? Thank you and let me know if there is something wrong!

This is why I've created automated tests and they say:

-- content/ws24/bachelor/b6-elara-health/Logo.svg does not match the pattern '^[a-z][^A-Z]*.([a-z]{2,4})$'

ERROR: not all files match the file name conventions

Looking at your commit this make sense, as you've only changed the reference, not the actual file name itself.....

@bkleinen
Copy link
Contributor

Please change the file name!!!

@bkleinen bkleinen changed the title B6 - first draft B6 - first release Jan 23, 2025
@bkleinen bkleinen merged commit b58cd03 into htw-imi-showtime:main Jan 23, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants