hackforla / lucky-parking

Visualization of parking data to assist in understanding of the effects of parking policies on a neighborhood by neighborhood basis in the City of Los Angeles
https://www.hackforla.org/projects/lucky-parking.html
34 stars 60 forks source link

[CICD] [Spike] Create release workflow #550

Open glenflorendo opened 11 months ago

glenflorendo commented 11 months ago

User Story

As a developer, I want to automate the management of change sets using the @changesets/cli npm package in our pnpm monorepo, so that we can streamline the process of versioning and publishing packages, saving time and reducing the risk of errors.

Description

Automating change sets with the @changesets/cli npm package will allow us to easily track and manage changes to our packages. By automating this process, we can ensure that every change is recorded and versioned correctly, making it easier to maintain our monorepo and track the history of our packages.

Create a new file named release.yaml inside the .github/workflows directory. This file will define the release workflow. The workflow should be triggered whenever a pull request is merged into the stable branch. This may be difficult to test as we do not currently use that branch. Connect with @glenflorendo if you experience difficulties with this ticket.

Research how we can use @changesets/cli as part of our release workflow to create and apply change sets. This will help us manage versioning and publishing of packages in our monorepo.

Verify that the automation process is reliable and does not introduce any errors or inconsistencies.

Acceptance Criteria

Technical References

parcheesime commented 5 months ago

I completed parts 1 and 2 for issue #550: Create the release.yaml file in the correct directory. Trigger the workflow on pull requests merged into the stable branch. I'll research, part 3, changesets this weekend.

parcheesime commented 5 months ago

Update: I've updated our project documentation to include details on how we're integrating Rush into our workflow using changesets. The changes aim to streamline our monorepo management, offering more efficient handling of our projects.

For a comprehensive understanding of the updates and how to work with Rush and changesets, see the updated section in our changesets documentation: Link to the document.