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] Add documentation for release process #401

Merged
merged 8 commits into from
Jul 22, 2024

Conversation

narin
Copy link
Contributor

@narin narin commented Jul 17, 2024

Description of Change

Adds documentation about our release process to the documentation site, outlining cadence, automation, git tagging, naming, change logs, and notifications.

Testing Packages

N/A

Screenshots/Video

localhost_3000_va-mobile-app_design_About_For%20engineers_releaseProcess

Testing

  • Tested on Web

PR Checklist

Code reviewer validation:

  • General
    • PR is linked to ticket(s)
    • PR has changelog label applied if it's to be included in the changelog
    • Acceptance criteria:
      • All satisfied or
      • Documented reason for not being performed or
      • Split to separate ticket and ticket is linked by relevant AC(s)
    • Above PR sections adequately filled out
    • If any breaking changes, in accordance with the pre-1.0.0 versioning guidelines: a CU ticket has been created for the VA Mobile App detailing necessary adjustments with the package version that will be published by this ticket
  • Code
    • Tests are included if appropriate (or split to separate ticket)
    • New functions have proper TSDoc annotations

Publish

If changes warrant a new version per the versioning guidelines and the PR is approved and ready to merge:

@narin narin requested a review from a team as a code owner July 17, 2024 19:43
@TimRoe
Copy link
Contributor

TimRoe commented Jul 17, 2024

Finding the corresponding branch in the app repo, instead of adding the same document it should just update the following section in docusaurus.config.js:

engineeringDocForm('documentation', 'documentation', [
      'contributing.md',
      'namingConventions.md',
      'overview.md',
      'testing.md',
      'versioning.md',
    ]),

with releaseProcess.md to pull it automatically including any changes from our repo. The file itself shouldn't be added in the app repo or it causes weird tag-along changes to other PRs updating documentation.

## Release notes
A [changelog](changelog.md) is automatically generated upon each release which
notes the merged pulled requests and closed issues since the last release. A
slack notification is also sent to the [#va-mobile-library](https://dsva.slack.com/archives/C062TM03HN2)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
slack notification is also sent to the [#va-mobile-library](https://dsva.slack.com/archives/C062TM03HN2)
slack notification is also sent to the [#va-mobile-library-alerts](https://dsva.slack.com/archives/C062TM03HN2)

Copy link
Contributor

@TimRoe TimRoe left a comment

Choose a reason for hiding this comment

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

Approving, but a few minor things to tweak prior to merge.

Comment with more meaningful adjustment on the flagship side not directly relevant to this PR.

@narin
Copy link
Contributor Author

narin commented Jul 22, 2024

Fixed links and created a new PR in the va-mobile-app repo with the only change being releaseProcess.md added to the list of docusaurus imports.

@narin narin merged commit 94559d7 into main Jul 22, 2024
5 of 6 checks passed
@narin narin deleted the feature/6921-narin-document-release-process branch July 22, 2024 15:24
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.

2 participants