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

chore: add release-please #288

Merged
merged 7 commits into from
Jan 21, 2021
Merged

chore: add release-please #288

merged 7 commits into from
Jan 21, 2021

Conversation

JGAntunes
Copy link
Contributor

This PR partially addresses #285. The idea is to provide a way to tag, release and bump the versions of both package.json and swagger.yml files. I tried running some tests on this repo but unfortunately seems like release-please will always create PRs against the mainline. As such I've ran some tests yesterday on a small repo - JGAntunes/actions-playground#1 - testing auto-commit. The idea here is to rely on it as a workaround to bump the swagger.yml file based on package.json version (which is initially done by release-please).

For this to work I'll need to add a secret to the repo (currently don't have access, maybe you can help me witht it @erezrokah?), similar to what we've done, maybe we can usenetlify-bots access token? - netlify/cli#1778 (comment)

@JGAntunes JGAntunes added type: chore work needed to keep the product and development running smoothly proj/align-npm-publishing labels Jan 20, 2021
@JGAntunes JGAntunes requested a review from erezrokah January 20, 2021 14:56
@JGAntunes JGAntunes requested a review from a team as a code owner January 20, 2021 14:56
@netlify
Copy link

netlify bot commented Jan 20, 2021

✔️ Deploy preview for open-api ready!

🔨 Explore the source changes: f452ce9

🔍 Inspect the deploy logs: https://app.netlify.com/sites/open-api/deploys/60085ddfcc231d00098f3637

😎 Browse the preview: https://deploy-preview-288--open-api.netlify.app

@erezrokah
Copy link
Contributor

For this to work I'll need to add a secret to the repo (currently don't have access, maybe you can help me witht it @erezrokah?), similar to what we've done, maybe we can usenetlify-bots access token? - netlify/cli#1778 (comment)

Thanks @JGAntunes I've added the secret. How are we dealing with generating the go client?

Copy link
Contributor

@erezrokah erezrokah left a comment

Choose a reason for hiding this comment

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

Added a few comments, but will delegate to the Backend the rest of the review.

package.json Show resolved Hide resolved
.github/workflows/swagger-bump.yml Outdated Show resolved Hide resolved
@JGAntunes
Copy link
Contributor Author

Thanks @JGAntunes I've added the secret. How are we dealing with generating the go client?

I've added a more extensive comment covering that @erezrokah - #285 (comment)

Copy link
Contributor

@mraerino mraerino left a comment

Choose a reason for hiding this comment

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

from a process level this looks fine.

this still expects people to manually regenerate the Go client right?

since this has always been the case this is not a blocker: can we think of a process where PRs are denied when the go code is not up-to-date?
that would also block releases that had this problem (but should not if we never merged PRs with failing checks).

@mraerino mraerino requested a review from erezrokah January 20, 2021 18:02
@JGAntunes
Copy link
Contributor Author

this still expects people to manually regenerate the Go client right?

@mraerino that's correct yes, I've went through a more lengthy boring explanation here - #285 (comment) - but essentially we can come out with an action to verify if new files are generated through make all and haven't been checked in, and fail the build in that case. I would rather have it as a separate PR though. Maybe later on we can improve the automation for generating the go client, but at least that way we would already have some safeguards in place.

@JGAntunes JGAntunes merged commit f9441e9 into master Jan 21, 2021
@JGAntunes JGAntunes deleted the chore/release-please branch January 21, 2021 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proj/align-npm-publishing type: chore work needed to keep the product and development running smoothly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants