Skip to content
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

CI Production Workflows for Docker and Docs #901

Merged
merged 4 commits into from
Jul 15, 2022

Conversation

SteveDMurphy
Copy link
Contributor

@SteveDMurphy SteveDMurphy commented Jul 14, 2022

Closes #807

Code Changes

  • Add a conditional step to check if the tag used matches a release
  • Include the current image when pushing a production image
  • Parse the github.event.ref to publish the version specific docs
  • Mimic the conditional step for docs publishing

Steps to Confirm

  • Set up a testing repo to ensure the workflow worked
  • Add a test nox command to print out the update IMAGE constant with version

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation Updated:
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)
  • Issue Requirements are Met
  • Relevant Follow-Up Issues Created
  • Update CHANGELOG.md

Description Of Changes

Spent some time in a test repo to ensure the workflow updates should work for us.

I'm unsure still if the nox changes are sufficient, or if there should be a separate constant used for the current working version.

Another additional question is if we want to retroactively publish docs versions that were missed 🤔

@SteveDMurphy SteveDMurphy self-assigned this Jul 14, 2022
@SteveDMurphy SteveDMurphy added the bug Something isn't working label Jul 14, 2022
@SteveDMurphy SteveDMurphy changed the title Docker CI Production Workflow CI Production Workflows for Docker and Docs Jul 14, 2022
@SteveDMurphy SteveDMurphy marked this pull request as ready for review July 14, 2022 16:10
@SteveDMurphy SteveDMurphy requested a review from a team July 14, 2022 16:10
Copy link
Contributor

@earmenda earmenda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

Copy link
Contributor

@ThomasLaPiana ThomasLaPiana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's pretty cool, good solution :D

@ThomasLaPiana
Copy link
Contributor

@SteveDMurphy I don't feel a need to publish old docs versions, I think it'll be good enough to have going forward but not worth back-filling

@SteveDMurphy SteveDMurphy merged commit 9f4fab9 into main Jul 15, 2022
@SteveDMurphy SteveDMurphy deleted the SteveDMurphy-807-docker-workflow branch July 15, 2022 15:57
allisonking pushed a commit that referenced this pull request Jul 28, 2022
* Step output conditional for workflow, tag to image

* Have doc publish with version number

* remove TAG env var from workflows

* changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docker prod push workflow skipped on release
3 participants