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

Added releasing documentation #980

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,48 @@ 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.
- Bootstrap a new `next` branch with the new version number and generated files.

## Development

Running the project locally:

```bash
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/).
Expand Down