Update Release Notes Workflow #1055
Conversation
1e108bb to
d42ceb9
Compare
There was a problem hiding this comment.
Ok so I think the underlying method is fine, I think we're going to trip ourselves up pretty quick with the implementations. So essentially, if we commit the release notes with the data in to Git that's going to get pretty messy, pretty quick.
What I suggest we do is generate the release notes as part of the main deployment pipeline and never commit them. That way the site will be up to date and Git will just store the template. We can still run the cron job to update the docs daily but I think this gives us the best of both worlds
|
|
||
| --- | ||
|
|
||
| ## [fluent-mongo-driver](https://github.com/vapor/fluent-mongo-driver) |
There was a problem hiding this comment.
Let's remove this - we shouldn't be encouraging people to be using Fluent with Mongo
|
|
||
| --- | ||
|
|
||
| ## [core](https://github.com/vapor/core) |
| --- | ||
|
|
||
| ## [api-docs](https://github.com/vapor/api-docs) | ||
| [**{{API_DOCS_RELEASE}}**](https://github.com/vapor/api-docs/releases/tag/{{API_DOCS_ID}}) |
There was a problem hiding this comment.
We don't tag releases so can remove this I think
| schedule: | ||
| # - cron: '0 0 * * *' # Daily at Midnight | ||
| # - cron: '0 0 * * 0' # Weekly every Sunday at Midnight | ||
| - cron: '0 0 */14 * 0' # Every two weeks on Sunday at Midnight |
There was a problem hiding this comment.
I'd be happy with daily if it's not too noisy
| on: | ||
| schedule: | ||
| # - cron: '0 0 * * *' # Daily at Midnight | ||
| # - cron: '0 0 * * 0' # Weekly every Sunday at Midnight |
| git config --global user.email 'actions@github.com' | ||
| git add docs/release-notes.md | ||
| git commit -m 'Update Vapor Release Notes' | ||
| git push |
There was a problem hiding this comment.
Given a commit to main deploys anyway, do we need this trigger below?
There was a problem hiding this comment.
My one concern here is that new deployments will wipe out the release notes. This is also going to get overwritten almost straight away and then just committed. Will put this is the main body
|
@0xTim I'll review the changes and let you know. |
Proposal: Automated Workflow for Fetching Vapor Repositories and Managing Release Notes
This Pull Request introduces an automated action workflow using the pozetroninc/github-action-get-latest-release tool. The workflow will:
Additional Consideration:
Since the release notes for all Vapor repositories are written in English, I propose that the Release Notes page should remain in English and not be translated into other languages. This avoids having outdated translations, as the automated workflow only updates the main English page.