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

Add GitHub Workflow to automate release generation #89

Merged
merged 9 commits into from
Jan 9, 2024

Conversation

joanlopez
Copy link
Contributor

@joanlopez joanlopez commented Jan 3, 2024

In order to align this jslib with what was discussed (and consensuated) for k6-jslib-summary, and set up here, this pull request:
- Removes the build directory from control versioned files, in favor of automated releases
- Sets up a GH Workflow to automate releases from Git tags push.
- Updates the contribution guidelines accordingly.

UPDATE (08/01)

It adds a new GitHub Workflow aiming the (future) automation of releases, heavily inspired by https://github.com/grafana/k6-jslib-summary/blob/main/.github/workflows/release.yml, but using Webpack & NPM instead of Yarn to adjust it to the project needs.

I left some comments in form of open questions inline.

@joanlopez joanlopez self-assigned this Jan 3, 2024
@joanlopez joanlopez requested a review from a team as a code owner January 3, 2024 16:05
@joanlopez joanlopez requested review from codebien, olegbespalov and oleiade and removed request for a team January 3, 2024 16:05
.gitignore Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@oleiade
Copy link
Member

oleiade commented Jan 4, 2024

As we're at it, I thought of renaming the webpack command to build, to align it with what I've observed in the ecosystem. It's a rather small change I believe, but it would also help "hide" that we rely on webpack which feels like an implementation detail.

What do you think?

@joanlopez
Copy link
Contributor Author

joanlopez commented Jan 4, 2024

As we're at it, I thought of renaming the webpack command to build, to align it with what I've observed in the ecosystem. It's a rather small change I believe, but it would also help "hide" that we rely on webpack which feels like an implementation detail.

What do you think?

I prepared that in the first pull request I prepared around this, but then I did care less because in this second approach the folder isn't being versioned at all. But yeah, it's a minor but fair change, that I can easily add in this pull request. Thanks!

Copy link

@olegbespalov olegbespalov left a comment

Choose a reason for hiding this comment

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

TBH, after a discussion in treads, I think that maybe removing the build directory for k6-jslib-aws isn't a good thing (or perhaps it is too early to decide).

Also, I feel that the idea of porting the changes to the jslib.k6.io isn't completely clear without a prototype (a PR to the jslib.k6.io) that could demonstrate the new flow.

How about putting this PR on pause? I'll sketch up the PR with the routine automation I mentioned in #89 (comment), and we can continue the discussion.

@joanlopez joanlopez changed the title Stop versioning builds and use CI Add GitHub Workflow to automate release generation Jan 8, 2024
@joanlopez
Copy link
Contributor Author

Hey @olegbespalov, @oleiade,

After our discussion, and as per what's commented in #89 (comment), I decided to update this pull request to just add the release workflow, so at least we can turn that step into a 1-click automation (it just requires creating the tag) and move on.

Wdyt?

@joanlopez joanlopez merged commit 7bc5310 into main Jan 9, 2024
3 checks passed
@oleiade oleiade deleted the replace-build-with-ci branch September 24, 2024 08:06
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.

3 participants