Skip to content

Commit

Permalink
docs: Document skip URL check (#3456)
Browse files Browse the repository at this point in the history
2 Open questions:

1. Coming from [this
comment](#3453 (comment)):
Is there an automated validation check from the versioning pattern?
2. Is there a version pattern for projects that have not a single tagged
release? Should I use the date pattern here?
  • Loading branch information
hofbi authored Dec 19, 2024
1 parent 09273ac commit aecf8df
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The script will generate all require changes based on your input, please review,
If you are the project owner, you can set up the [Publish to BCR](https://github.com/apps/publish-to-bcr) Github App for your repository to automatically send a PR to the BCR when cutting a new release.

When manually editing files you may find `bazel run -- //tools:update_integrity foomod` useful to update the integrity hashes in foomod's source.json file.
The tool also accepts a `--version` option to update the source.json of a specific version of the module (instead of latest).
The tool also accepts a `--version` option to update the `source.json` of a specific version of the module (instead of latest).

### Testing your change locally

Expand Down Expand Up @@ -47,14 +47,14 @@ Validations performed in the scripts are:

- Verify the module version exists in the `metadata.json` of the module.
- Verify the source archive URL matches the source repository specified in `metadata.json`.
- Verify the source archive URL is stable if it comes from GitHub. (See [this discussion](https://github.com/bazel-contrib/SIG-rules-authors/issues/11#issuecomment-1029861300))
- Verify the source archive URL is stable if it comes from GitHub. (See [this discussion](https://github.com/bazel-contrib/SIG-rules-authors/issues/11#issuecomment-1029861300)). Comment `@bazel-io skip_check unstable_url` to skip this check.
- Verify the integrity values of the source archive and patch files (if any) are correct.
- Verify the checked-in MODULE.bazel file matches the one in the extracted and patched source tree.
- Verify the checked-in `MODULE.bazel` file matches the one in the extracted and patched source tree.
- Check if the module is new or the `presubmit.yml` file is changed compared to the last version, if so a BCR maintainer review will be required to run jobs specified in `presubmit.yml`.

Additional validations implemented in the [bcr_presubmit.py](https://github.com/bazelbuild/continuous-integration/blob/master/buildkite/bazel-central-registry/bcr_presubmit.py) script:

- The checked-in MODULE.bazel, source.json, patches files are not modified in the PR.
- The checked-in `MODULE.bazel`, `source.json`, patches files are not modified in the PR.
- The files outside of `modules/` directory are not modified in the pull request if the PR is adding a new module version.

### Anonymous module test
Expand Down

0 comments on commit aecf8df

Please sign in to comment.