XaverianTeamRobotics / CenterstageFTCrobotcontroller

make robot move
https://robotics.xbhs.net/
BSD 3-Clause Clear License
8 stars 4 forks source link

Create an action for test deployments for docs builds #595

Closed MatthewL246 closed 9 months ago

MatthewL246 commented 10 months ago

Changes:

I created a job for the GitHub Pages action that uploads a test deployment to Cloudflare Pages. I tested this on my fork using my own Cloudflare account, see an example PR here: https://github.com/MatthewL246/FtcRobotController/pull/7.

Controls and Usage:

When you are making a documentation update, make sure to name your branch starting with docs/. After the build completes, you will receive a comment from the GitHub Actions bot on your PR with a link to a preview of the deployment.

Required steps before merging:

  1. Someone on the XBHS Cloudflare account should set up a Cloudflare Pages project for xbhs-robotics-docs.pages.dev.
  2. Create a secret in this repo named CLOUDFLARE_ACCOUNT_ID with the account ID.
  3. Create a secret in this repo named CLOUDFLARE_API_TOKEN with an API token that has edit access to Account.Cloudflare Pages.

Reviewers:

@XaverianTeamRobotics/senior-programmers

Closes #593.

michaell4438 commented 10 months ago

Yeah I also do not have secrets access :( so lets not merge it right now

michaell4438 commented 10 months ago

I looked at the fork though and i do really like that change, so I think it is a needed one

MatthewL246 commented 10 months ago

Alright, I think this is pretty much completed. We just need to set up Cloudflare and the secrets before merging.

michaell4438 commented 10 months ago

@MatthewL246 Maybe email roche today. I have the password for our cloud flare account if you need it

MatthewL246 commented 10 months ago

@michaell4438 Done. Did you reserve the Pages project domain?

MatthewL246 commented 10 months ago

Alright, the Cloudflare project is ready: xbhs-robotics-docs.pages.dev. I'll create the API token when necessary.

github-actions[bot] commented 9 months ago

Your docs changes were built successfully! View a preview of them at https://f382469e.xbhs-robotics-docs.pages.dev

MatthewL246 commented 9 months ago

@michaell4438 can i haz approval