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

Docs: tag-based release #479

Merged
merged 3 commits into from
Jul 12, 2024
Merged

Docs: tag-based release #479

merged 3 commits into from
Jul 12, 2024

Conversation

angela-tran
Copy link
Member

Closes #427

Referenced the release checklist from https://github.com/cal-itp/eligibility-server/blob/main/.github/ISSUE_TEMPLATE/release.yml and the Benefits documentation on Making a release.

Builds off #478

similar to the steps in our release issue template but with commands
@angela-tran angela-tran self-assigned this Jul 10, 2024
@angela-tran angela-tran requested a review from a team as a code owner July 10, 2024 23:03
@angela-tran
Copy link
Member Author

I'm not sure why this line is not rendering a button:

[Start a new Release on Github](https://github.com/cal-itp/eligibility-server/issues/new?labels=release&template=release.yml&title=Make+a+Release){ .md-button }

image


It uses the exact same syntax as the line in Benefits, which does render a button:

image

I compared their mkdocs.yml files and can't find an explanation.

@angela-tran angela-tran linked an issue Jul 10, 2024 that may be closed by this pull request
3 tasks
@thekaveman
Copy link
Member

@angela-tran one difference is we pin the versions of some of the mkdocs requirements in Benefits: https://github.com/cal-itp/benefits/blob/main/docs/requirements.txt

Maybe try those same version pins here?

Base automatically changed from docs/package-tags to main July 11, 2024 14:58
Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

@angela-tran
Copy link
Member Author

I figured out it was because we were missing attr_list! 😅

https://squidfunk.github.io/mkdocs-material/reference/buttons

@angela-tran angela-tran merged commit 7c0b5ac into main Jul 12, 2024
6 checks passed
@angela-tran angela-tran deleted the docs/tag-based-release branch July 12, 2024 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs about tag-based release process
2 participants