From d500f22b7f3dec71606262e05095907cb7d2c5aa Mon Sep 17 00:00:00 2001 From: roll Date: Tue, 24 Sep 2024 13:38:26 +0100 Subject: [PATCH 1/2] Added releasing documentation --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 8afffcc5..121d9834 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,30 @@ Data Package is a standard consisting of a set of simple yet extensible specific One can contribute to the documentation by clicking on the "Edit Page" button on a site page and create a pull request directly on Github. +The project uses two main branches: `main` and `next`: + +- The `main` branch is the default branch and is the one that is deployed to the live site. PRs that make quick corrections (e.g. fixing a typo or updating a website style) should be merged with this branch. +- The `next` branch is the main development branch that accumulates changes for the next release. PRs that affect the standard (e.g. changing standard texts or profiles) should be merged with this branch. + +## Releasing + +When then `next` branch is ready for release: + +- A maintainer should create a PR from the `next` branch to the `main` branch and request a review from another maintainer. +- A reviewer should check the PR for version, profiles and changelog correctness, and approve the PR. +- A maintainer should merge the PR. + +When the PR is merged, Github Actions will automatically: + +> **NOTE:** The actual implementation is under development (https://github.com/frictionlessdata/datapackage/issues/976) + +- Create a new release on Github. +- Deploy the new version of the site. +- Sync the `next` branch with the `main` branch. +- Update the `next` branch with the new version number and generated files. + +## Development + Running the project locally: ```bash @@ -13,6 +37,18 @@ npm install npm start ``` +Building profiles: + +```bash +npm run profiles +``` + +Building the site: + +```bash +npm run build +``` + ## Funding This project is funded through [NGI0 Entrust](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/FrictionlessStandards/). From 9af0b128ad2498a037c97aa0cfa7eb57cf1ac76d Mon Sep 17 00:00:00 2001 From: roll Date: Tue, 24 Sep 2024 13:46:27 +0100 Subject: [PATCH 2/2] Updated readme --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 121d9834..e2265d82 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,7 @@ When the PR is merged, Github Actions will automatically: - Create a new release on Github. - Deploy the new version of the site. -- Sync the `next` branch with the `main` branch. -- Update the `next` branch with the new version number and generated files. +- Bootstrap a new `next` branch with the new version number and generated files. ## Development