Skip to content
Merged
Show file tree
Hide file tree
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
10 changes: 10 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Code owners are automatically requested to review when a pull request
# is opened (ready for review).
# See https://search.brave.com/search?q=About+code+owners+-+GitHub+Docs
Copy link

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL references a search engine query rather than directly linking to GitHub's official documentation. Consider using the direct documentation link: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Suggested change
# See https://search.brave.com/search?q=About+code+owners+-+GitHub+Docs
# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Copilot uses AI. Check for mistakes.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used the search link because documentation link could change and it was too long but I can change it back.


# A Ruleset is created in this GitHub repository to automatically request
# Copilot's review when pull requests are created as drafts or when they
# are ready for review.
# See https://github.com/iExecBlockchainComputing/PoCo/settings/rules/9055086

* @zguesmi @gfournieriExec @Le-Caignec
5 changes: 2 additions & 3 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,11 @@ on:
default: 'hardhat'

jobs:
# Build and test before deploying.
build-and-test:
pre-deploy:
uses: ./.github/workflows/main.yml

deploy:
needs: build-and-test
needs: pre-deploy
runs-on: ubuntu-latest
environment: ${{ inputs.network }} # Use the selected environment
permissions:
Expand Down
31 changes: 24 additions & 7 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,37 @@
# ⚠️ THIS WORKFLOW IS THE TRUSTED PUBLISHER CONFIGURED ON NPMJS.COM, DO NOT RENAME OR DELETE THIS FILE ⚠️

name: Publish NPM Package

on:
push:
tags:
- 'v*'

permissions:
id-token: write # Required for OIDC
packages: write
contents: read

jobs:
build-and-test:
pre-publish:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why set a particular name for this wf ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's to get clearer names here instead of the name repetition. It also helps better debug when there are issues.

image

uses: ./.github/workflows/main.yml

determine-dist-tag:
needs: pre-publish
runs-on: ubuntu-latest
outputs:
TAG: ${{ steps.set-dist-tag.outputs.TAG }}
steps:
- name: Determine package dist tag
id: set-dist-tag
run: |
if [[ "${GITHUB_REF#refs/tags/}" == *"-rc"* ]]; then
echo "TAG=rc" >> $GITHUB_OUTPUT
else
echo "TAG=latest" >> $GITHUB_OUTPUT
fi
publish:
needs: build-and-test
needs: determine-dist-tag
permissions:
id-token: write # Required for OIDC
packages: write
contents: read
uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/publish-npm.yml@publish-npm-v1.6.0
with:
tag: ${{ needs.determine-dist-tag.outputs.TAG }}
5 changes: 2 additions & 3 deletions .github/workflows/upgrade-facets.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,11 @@ on:
default: true

jobs:
# Build and test before upgrading.
build-and-test:
pre-upgrade:
uses: ./.github/workflows/main.yml

upgrade:
needs: build-and-test
needs: pre-upgrade
runs-on: ubuntu-latest
environment: ${{ inputs.network }} # Use the selected environment
permissions:
Expand Down
18 changes: 17 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ npm run verify:all -- --network <your network name> # e.g. arbitrum
This script automatically reads all deployed contract addresses and their constructor arguments from the deployment artifacts and verifies them on the relevant block explorer.
### Formatting
### Format
Format a specific file or files in a directory:
```
Expand Down Expand Up @@ -189,3 +189,19 @@ To render only storage diagrams:
```
npm run storage-to-diagrams
```
### Release
- **Final releases** are automated using [Release Please](https://github.com/googleapis/release-please). Major, minor, and patch versions should be published through the corresponding GitHub Actions workflows.
- **Prereleases** (`vX.Y.Z-rc.*`) should be created manually using:
```
npm run prerelease
```
This command will:
- Bump the RC version in `package.json` and `package-lock.json` files.
- Create a new commit with the version bump.
- Generate the corresponding Git tag.
Running this command ensures that the version in package.json matches the Git tag. This alignment is required for correct package publication and to automatically determine the appropriate npm dist tag (see [publish.yml](../.github/workflows/publish.yml)).
> Note: There is no need to create a full GitHub release for prerelease versions, a Git tag is sufficient.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@iexec/poco",
"version": "6.1.0-contracts",
"version": "6.1.0-rc.5",
"description": "iExec Proof of Contribution protocol smart contracts",
"author": "iExec",
"license": "Apache-2.0",
Expand All @@ -24,7 +24,8 @@
"sol-to-uml": "npx zx scripts/tools/sol-to-uml.mjs",
"puml-to-links": "npx zx scripts/tools/puml-to-links.mjs",
"storage-to-diagrams": "bash scripts/tools/storage-to-diagrams.sh",
"doc": "npx hardhat docgen"
"doc": "npx hardhat docgen",
"prerelease": "npm version prerelease --preid=rc -m 'chore: v%s'"
},
"files": [
"/abis",
Expand Down