Skip to content

Commit

Permalink
rename xpack-development
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Dec 5, 2023
1 parent 06419e5 commit 221a630
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/publish-github-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ name: GitHub Pages
# https://github.com/micro-os-plus/micro-test-plus-xpack/actions/workflows/publish-github-pages.yml
# https://micro-os-plus.github.io/micro-test-plus-xpack/

# TODO: remove xpack-develop
# TODO: remove xpack-development

on:
# Runs on pushes, if all conditions are met:
push:
# ... on the master branch ...
branches:
- 'xpack'
- 'xpack-develop'
- 'xpack-development'
# ... skip tags only ...
tags-ignore:
- '**'
Expand Down Expand Up @@ -120,6 +120,6 @@ jobs:
with:
artifact_name: github-pages

# Branch "xpack-develop" is not allowed to deploy to github-pages due to environment protection rules.
# Branch "xpack-development" is not allowed to deploy to github-pages due to environment protection rules.
# https://github.com/micro-os-plus/micro-test-plus-xpack/settings/environments/1692678824/edit

2 changes: 1 addition & 1 deletion tests/scripts/trigger-workflow-test-all.sh
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ GITHUB_ORG="micro-os-plus"
GITHUB_REPO="micro-test-plus-xpack"
# GITHUB_API_DISPATCH_TOKEN must be present in the environment.

branch="xpack-develop"
branch="xpack-development"
workflow_id="test-all.yml"

while [ $# -gt 0 ]
Expand Down
6 changes: 3 additions & 3 deletions website/pages/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,12 +130,12 @@ The project uses Git and is hosted on GitHub as
Apart from the unused `master` branch, there are two active branches:

- `xpack`, with the latest stable version (default)
- `xpack-develop`, with the current development version
- `xpack-development`, with the current development version

All development is done in the `xpack-develop` branch, and contributions via
All development is done in the `xpack-development` branch, and contributions via
Pull Requests should be directed to this branch.

When new releases are published, the `xpack-develop` branch is merged
When new releases are published, the `xpack-development` branch is merged
into the `xpack` branch.

## Build & integration info
Expand Down
20 changes: 10 additions & 10 deletions website/pages/maintainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ git clone \
~/Work/micro-os-plus/micro-test-plus-xpack.git
```

For development purposes, clone the development branch (`xpack-develop`):
For development purposes, clone the development branch (`xpack-development`):

```sh
rm -rf ~/Work/micro-os-plus/micro-test-plus-xpack.git && \
mkdir -p ~/Work/micro-os-plus && \
git clone \
--branch xpack-develop \
--branch xpack-development \
https://github.com/micro-os-plus/micro-test-plus-xpack.git \
~/Work/micro-os-plus/micro-test-plus-xpack.git
```
Expand All @@ -49,13 +49,13 @@ xpm link -C ~/Work/micro-os-plus/micro-test-plus-xpack.git
## Get helper sources

The project has a dependency to a common **helper**; clone the
`xpack-develop` branch and link it to the central xPacks store:
`xpack-development` branch and link it to the central xPacks store:

```sh
rm -rf ~/Work/micro-os-plus/build-helper-xpack.git && \
mkdir -p ~/Work/micro-os-plus && \
git clone \
--branch xpack-develop \
--branch xpack-development \
https://github.com/micro-os-plus/build-helper-xpack.git \
~/Work/micro-os-plus/build-helper-xpack.git
```
Expand Down Expand Up @@ -112,7 +112,7 @@ There are no fixed releases.

In the `micro-os-plus/micro-test-plus-xpack` Git repo:

- switch to the `xpack-develop` branch
- switch to the `xpack-development` branch
- if needed, merge the `xpack` branch

No need to add a tag here, it'll be added when the release is created.
Expand Down Expand Up @@ -193,14 +193,14 @@ xpm run test-all -C ~/Work/micro-os-plus/micro-test-plus-xpack.git/tests

### Publish on the 'npmjs.com' server

- select the `xpack-develop` branch
- select the `xpack-development` branch
- commit all changes
- `npm pack` and check the content of the archive, which should list
only `package.json`, `README.md`, `LICENSE`, `CHANGELOG.md`,
the sources and CMake/meson files;
possibly adjust `.npmignore`
- `npm version patch`, `npm version minor`, `npm version major`
- push the `xpack-develop` branch to GitHub
- push the `xpack-development` branch to GitHub
- the `postversion` npm script should also update tags via `git push origin --tags`
- wait for the CI job to complete
(<https://github.com/micro-os-plus/micro-test-plus-xpack/actions/workflows/ci.yml>)
Expand All @@ -215,7 +215,7 @@ For this:

- start the `~/actions-runners/micro-os-plus/run.sh &` runner on
`xbbma`, `xbbla64` and `xbbla32`
- ensure that the `xpack-develop` branch is pushed
- ensure that the `xpack-development` branch is pushed
- run the `trigger-workflow-test-all` action
- wait for the **test-all** job to complete
(<https://github.com/micro-os-plus/micro-test-plus-xpack/actions/workflows/test-all.yml>)
Expand All @@ -234,9 +234,9 @@ The version is visible at:
When the package is considered stable:

- with a Git client (VS Code is fine)
- merge `xpack-develop` into `xpack`
- merge `xpack-development` into `xpack`
- push to GitHub
- select `xpack-develop`
- select `xpack-development`

### Tag the npm package as 'latest'

Expand Down
4 changes: 2 additions & 2 deletions website/pages/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -619,14 +619,14 @@ npm install --global xpm@latest

### Clone the project

To clone the development branch (`xpack-develop`), run the following commands in a
To clone the development branch (`xpack-development`), run the following commands in a
terminal (on Windows use the _Git Bash_ console):

```sh
rm -rf ~/Work/micro-os-plus/micro-test-plus-xpack.git && \
mkdir -p ~/Work/micro-os-plus && \
git clone \
--branch xpack-develop \
--branch xpack-development \
https://github.com/micro-os-plus/micro-test-plus-xpack.git \
~/Work/micro-os-plus/micro-test-plus-xpack.git
```
Expand Down

0 comments on commit 221a630

Please sign in to comment.