[add] gh-pages script and update README

JoyOfCodingPDX / GettingStarted

Helps students in Contemporary Software Development get started with the programming assignments.

https://web.cecs.pdx.edu/~whitlock/

Apache License 2.0

6 stars 15 forks source link

[add] gh-pages script and update README #40

Open kesquerra opened 2 years ago

kesquerra commented 2 years ago

Adds gh-pages script that:
- creates gh-pages branch if it doesn't exist
- checkouts existing or new branch
- deletes root level README.md
- updates .gitignore to remove *.zip (mvnw scm:publish pushes .zip files)
- commits changes to gh-pages branch
- checkouts main and runs:
- mvnw site
- mvnw site:stage
- mvnw scm-publish:publish-scm
- Update README.md to reflect *.zip changes in .gitignore

DavidWhitlock commented 2 years ago

I want to think on this one some more before I determine whether or not I want to merge it. I'm not sure if I want to hide the details of creating the gh-pages branch from the students.

kesquerra commented 2 years ago

I did remove the commit that deletes the instructions in the readme to setup the gh-pages branch. Now that I think about it, the script might be better suited to check that gh-pages is setup correctly and then run the maven processes, or else notify user of changes to be made. This might even be better suited for a workflow