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 Nov 21, 2024
1 parent 4eabde6 commit 384e465
Show file tree
Hide file tree
Showing 13 changed files with 45 additions and 45 deletions.
14 changes: 7 additions & 7 deletions README-MAINTAINER.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ git clone \
~/Work/micro-os-plus/build-helper-xpack.git
```

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

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

In the `micro-os-plus/build-helper` Git repo:

- switch to the `xpack-develop` branch
- switch to the `` 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 @@ -93,14 +93,14 @@ related to the new version:

### Commit the new version

- select the `xpack-develop` branch
- select the `` 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 `doxygen-awesome-*.js` and `doxygen-custom/*` files;
possibly adjust `.npmignore`
- `npm version patch`, `npm version minor`, `npm version major`
- push the `xpack-develop` branch to GitHub
- push the `` 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/build-helper-xpack/actions/workflows/ci.yml>)
Expand All @@ -123,9 +123,9 @@ Test the package.
When the package is considered stable:

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

## Tag the npm package as `latest`

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ git submodule add https://github.com/micro-os-plus/build-helper-xpack.git \
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
- ``, with the current development version

All development is done in the `xpack-develop` branch, and contributions via
All development is done in the `` 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 `` branch is merged
into `xpack`.

## Developer info
Expand Down
8 changes: 4 additions & 4 deletions dev-scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ The first argument is an optional destination folder path. The default is
`${HOME}/Work/micro-os-plus-xpack-repos`.

```sh
curl -L https://raw.githubusercontent.com/micro-os-plus/build-helper-xpack/xpack/scripts/clone-and-link-all-git-repos.sh | bash
curl -L https://raw.githubusercontent.com/micro-os-plus/build-helper-xpack/xpack/scripts/clone-and-link-all-git-repos.sh | bash
```

To get the very latest version, get the script from the
`xpack-develop` branch:
`` branch:

```sh
curl -L https://raw.githubusercontent.com/micro-os-plus/build-helper-xpack/xpack-develop/scripts/clone-and-link-all-git-repos.sh | bash
curl -L https://raw.githubusercontent.com/micro-os-plus/build-helper-xpack//scripts/clone-and-link-all-git-repos.sh | bash
```


Expand Down Expand Up @@ -57,7 +57,7 @@ It can be invoked with:
bash convert-arm-asm-to-c.sh ${input} >${output}
```

The input file is usually an Arm assembly file from the vendor CMSIS,
The input file is usually an Arm assembly file from the vendor CMSIS,
something like:

- `${HOME}/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.1/Drivers/CMSIS/Device/ST/STM32F0xx/Source/Templates/arm/startup_stm32f030x6.s`
Expand Down
2 changes: 1 addition & 1 deletion dev-scripts/clone-and-link-all-git-repos.sh
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ function clone-and-link()
local repo_name="$1"

echo
clone "${repo_name}" "xpack-develop"
clone "${repo_name}" ""

# Link it to the central xPacks repo.
xpm link -C ${repo_name}.git
Expand Down
4 changes: 2 additions & 2 deletions dev-scripts/git-commit.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ cd "$1/.."
echo
echo $1
git switch xpack
git merge xpack-develop
git merge
git push
git switch xpack-develop
git switch
__EOF__

Expand Down
4 changes: 2 additions & 2 deletions dev-scripts/git-merge-develop.sh
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ cd "$1/.."
echo
echo $1
git switch xpack
git merge xpack-develop
git merge
git push
git switch xpack-develop
git switch
__EOF__

Expand Down
6 changes: 3 additions & 3 deletions templates/README-3RD-PARTY.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@ There are three active branches:

- `master`, follows the original Arm `master`
- `xpack`, with the latest stable version (default)
- `xpack-develop`, with the current development version
- ``, with the current development version

All development is done in the `xpack-develop` branch, and contributions via
All development is done in the `` branch, and contributions via
Pull Requests should be directed to this branch. (Only contributions
related to the xPack integration are accepted, functional contributions
should be addressed to the upstream project.)

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

## Developer info
Expand Down
18 changes: 9 additions & 9 deletions templates/README-MAINTAINER-3RD-PARTY.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ git clone \
~/Work/micro-os-plus/xxx-yyy-xpack.git
```

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

```sh
rm -rf ~/Work/micro-os-plus/xxx-yyy-xpack.git && \
mkdir -p ~/Work/micro-os-plus && \
git clone \
--branch xpack-develop \
--branch \
https://github.com/xpack-3rd-party/xxx-yyy-xpack.git \
~/Work/micro-os-plus/xxx-yyy-xpack.git
```
Expand Down Expand Up @@ -76,7 +76,7 @@ xpm run test-all -C ~/Work/micro-os-plus/micro-test-plus-xpack.git

The above procedure will allow to develop the project itself, but the
dependencies will be read-only; to be able to contribute to them,
also clone the development branch (`xpack-develop`)es of the source xPacks dependencies
also clone the development branch (``)es of the source xPacks dependencies
into a folder of your choice and add links from the central xPacks
storage to them by running `xpack link` in each folder.

Expand Down Expand Up @@ -118,7 +118,7 @@ There are no fixed releases, they generally follow the upstream releases.

In the `xpack-3rd-party/xxx-yyy-xpack` Git repo:

- switch to the `xpack-develop` branch
- switch to the `` 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 @@ -174,7 +174,7 @@ and the results are available at

## Publish on the npmjs.com server

- select the `xpack-develop` branch
- select the `` branch
- commit all changes
- update versions in `README-MAINTAINER-XPACK.md`
- update `CHANGELOG-XPACK.md`
Expand All @@ -184,7 +184,7 @@ and the results are available at
the sources and CMake/meson files;
possibly adjust `.npmignore`
- `npm version v0.1.0-1`
- push the `xpack-develop` branch to GitHub
- push the `` 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/xpack-3rd-party/xxx-yyy-xpack/actions/workflows/ci.yml>)
Expand All @@ -198,7 +198,7 @@ and macOS Apple Silicon.
For this:

- start the `~/actions-runners/micro-os-plus/run.sh &` runner on `xbbma` and `xbbla`
- ensure that the `xpack-develop` branch is pushed
- ensure that the `` branch is pushed
- run the `trigger-workflow-test-all` action
- wait for the **test-all** job to complete
(<https://github.com/xpack-3rd-party/xxx-yyy-xpack/actions/workflows/test-all.yml>)
Expand All @@ -217,9 +217,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 `` into `xpack`
- push to GitHub
- select `xpack-develop`
- select ``

## Test

Expand Down
16 changes: 8 additions & 8 deletions templates/README-MAINTAINER-XPACK.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ git clone \
~/Work/micro-os-plus/xxx-yyy-xpack.git
```

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

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

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

- switch to the `xpack-develop` branch
- switch to the `` 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 @@ -105,14 +105,14 @@ xpm run test-all -C ~/Work/micro-os-plus/xxx-yyy-xpack.git

### Publish on the npmjs.com server

- select the `xpack-develop` branch
- select the `` 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 `` 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/xxx-yyy-xpack/actions/workflows/ci.yml>)
Expand All @@ -126,7 +126,7 @@ and macOS Apple Silicon.
For this:

- start the `~/actions-runners/micro-os-plus/run.sh &` runner on `xbbma` and `xbbla`
- ensure that the `xpack-develop` branch is pushed
- ensure that the `` branch is pushed
- run the `trigger-workflow-test-all` action
- wait for the **test-all** job to complete
(<https://github.com/micro-os-plus/xxx-yyy-xpack/actions/workflows/test-all.yml>)
Expand All @@ -145,9 +145,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 `` into `xpack`
- push to GitHub
- select `xpack-develop`
- select ``

### Tag the npm package as `latest`

Expand Down
6 changes: 3 additions & 3 deletions templates/README-XPACK.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,12 @@ git submodule add https://github.com/micro-os-plus/xxx-yyy-xpack.git \
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
- ``, with the current development version

All development is done in the `xpack-develop` branch, and contributions via
All development is done in the `` 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 `` branch is merged
into `xpack`.

## Developer info
Expand Down
2 changes: 1 addition & 1 deletion templates/package-tests.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"https://github.com/xpack-dev-tools"
],
"devDependencies": {
"@micro-os-plus/build-helper": "github:micro-os-plus/build-helper-xpack#xpack-develop",
"@micro-os-plus/build-helper": "github:micro-os-plus/build-helper-xpack#",
"@micro-os-plus/diag-trace": "^4.2.1",
"@micro-os-plus/micro-test-plus": "^3.2.0",
"@xpack-dev-tools/cmake": "3.26.5-1.1",
Expand Down
2 changes: 1 addition & 1 deletion templates/package-xpack.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"@xpack-dev-tools/cmake": "3.23.5-1.1",
"@xpack-dev-tools/meson-build": "1.3.0-1.1",
"@xpack-dev-tools/ninja-build": "1.11.1-2.1",
"@micro-os-plus/build-helper": "github:micro-os-plus/build-helper-xpack#xpack-develop",
"@micro-os-plus/build-helper": "github:micro-os-plus/build-helper-xpack#",
"@micro-os-plus/micro-test-plus": "^3.1.1",
"@micro-os-plus/diag-trace": "^4.1.1"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ GITHUB_ORG="xpack-3rd-party"
GITHUB_REPO="xxx-yyy-xpack"
# GITHUB_API_DISPATCH_TOKEN must be present in the environment.

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

while [ $# -gt 0 ]
Expand Down

0 comments on commit 384e465

Please sign in to comment.