Compare commits

...

8 Commits

Author SHA1 Message Date
olayway
3366016c43 [.github/workflows][m]: add release workflow
The workflow creates a PR with version bumps and related changelog
files' updates, each time a commit containing a changeset
file is added on the main branch.
2023-06-05 15:56:37 +02:00
olayway
0e3d6ee262 [package.json][s]: add prerelease + release scripts 2023-06-05 15:56:37 +02:00
olayway
b6539eac2a [package.json][xs]: install @changesets/cli and
- install @changesets/cli and @changesets/changelog-github generator
2023-06-05 15:56:37 +02:00
olayway
2bfc1f7e18 [.changeset][xs]: link commits, PRs, and users
- link commits, PRs, and users in generated changelogs
2023-06-05 15:56:37 +02:00
olayway
20fd1b3b97 [package.json][xs]: setup npm workspaces 2023-06-05 15:56:37 +02:00
olayway
013b9072c9 [CONTRIBUTING.md][m]: add notes on changeset usage 2023-06-05 15:56:37 +02:00
olayway
1da0c3823d [.changeset][xs]: changeset init 2023-05-26 20:17:56 +02:00
olayway
03fd120bcd [package.json][xs]: install @changesests/cli 2023-05-26 20:17:56 +02:00
6 changed files with 25063 additions and 504 deletions

8
.changeset/README.md Normal file
View File

@ -0,0 +1,8 @@
# Changesets
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

14
.changeset/config.json Normal file
View File

@ -0,0 +1,14 @@
{
"$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
"changelog": [
"@changesets/changelog-github",
{ "repo": "datopian/portaljs" }
],
"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}

39
.github/workflows/release.yml vendored Normal file
View File

@ -0,0 +1,39 @@
name: Release
on:
push:
branches:
- main
concurrency: release-${{ github.ref }}
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Setup Node.js 16.x
uses: actions/setup-node@v3
with:
node-version: 16.x
- name: Install Dependencies
run: npm ci
- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
with:
publish: npm run release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
# - name: Send a Discord notification if a publish happens
# if: steps.changesets.outputs.published == 'true'
# uses: Ilshidur/action-discord@0.3.2
# with:
# args: 'The project {{ EVENT_PAYLOAD.repository.full_name }} has been deployed.'

View File

@ -26,10 +26,11 @@ If you'd like to work on one of the issues you can:
3. Clone the forked repository to your machine. 3. Clone the forked repository to your machine.
4. Create a feature branch (e.g. `50-update-readme`, where `50` is the number of the related issue). 4. Create a feature branch (e.g. `50-update-readme`, where `50` is the number of the related issue).
5. Commit your changes to the feature branch. 5. Commit your changes to the feature branch.
6. Push the feature branch to your forked repository. 6. Add changeset file describing the changes. (See section below)
7. Create a Pull Request against the original repository. 7. Push the feature branch to your forked repository.
8. Create a Pull Request against the original repository.
- add a short description of the changes included in the PR - add a short description of the changes included in the PR
8. Address review comments if requested by our demanding reviewers 😜. 9. Address review comments if requested by our demanding reviewers 😜.
If you have an idea for improvement, and it doesn't have a corresponding issue yet, simply submit a new one. If you have an idea for improvement, and it doesn't have a corresponding issue yet, simply submit a new one.
@ -62,6 +63,7 @@ or you can use just:
nx <target> <project> nx <target> <project>
# e.g. npx nx serve ckan # e.g. npx nx serve ckan
``` ```
if you have the `nx` binary installed globally in your machine if you have the `nx` binary installed globally in your machine
#### Running multiple tasks #### Running multiple tasks
@ -174,3 +176,23 @@ To learn more see this [offical docs page](https://nx.dev/reference/nx-json).
Each project also has it's own configuration file - `project.json`, where you can define and configure it's targets (and more). Each project also has it's own configuration file - `project.json`, where you can define and configure it's targets (and more).
To learn more see this [offical docs page](https://nx.dev/reference/project-configuration). To learn more see this [offical docs page](https://nx.dev/reference/project-configuration).
## Changesets and publishing packages
> This monorepo is set up with changesets versioning tool. See their [github repository](https://github.com/changesets/changesets) to learn more.
### What are Changesets?
Changesets are files that describe the intention of a contributor to bump a version of the package according to their changes. Changeset file holds two key bits of information: a version type (following semver), and change information to be added to a changelog.
### Adding changesets
In the root directory of the repo, run:
```
npx changeset
```
Select the package that has been changed, the semver version that should be bumped with it and a description of your changes. Please make sure to add the most accurate but also concise information.
To learn about semantic versioning standards see [this semver doc page](https://semver.org/).

25457
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,11 +1,18 @@
{ {
"name": "portaljs", "name": "portaljs",
"workspaces": ["./packages/*"],
"version": "0.0.0", "version": "0.0.0",
"license": "MIT", "license": "MIT",
"scripts": {}, "scripts": {
"changeset": "changeset",
"prerelease": "nx affected --targets=lint,test",
"release": "changeset publish"
},
"private": true, "private": true,
"devDependencies": { "devDependencies": {
"@babel/preset-react": "^7.14.5", "@babel/preset-react": "^7.14.5",
"@changesets/changelog-github": "^0.4.8",
"@changesets/cli": "^2.26.1",
"@nrwl/cypress": "15.9.2", "@nrwl/cypress": "15.9.2",
"@nrwl/eslint-plugin-nx": "^16.0.2", "@nrwl/eslint-plugin-nx": "^16.0.2",
"@nrwl/jest": "15.9.2", "@nrwl/jest": "15.9.2",