Skip to content

Commit aecf8df

Browse files
authored
docs: Document skip URL check (#3456)
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?
1 parent 09273ac commit aecf8df

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The script will generate all require changes based on your input, please review,
1717
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.
1818

1919
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.
20-
The tool also accepts a `--version` option to update the source.json of a specific version of the module (instead of latest).
20+
The tool also accepts a `--version` option to update the `source.json` of a specific version of the module (instead of latest).
2121

2222
### Testing your change locally
2323

@@ -47,14 +47,14 @@ Validations performed in the scripts are:
4747

4848
- Verify the module version exists in the `metadata.json` of the module.
4949
- Verify the source archive URL matches the source repository specified in `metadata.json`.
50-
- 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))
50+
- 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.
5151
- Verify the integrity values of the source archive and patch files (if any) are correct.
52-
- Verify the checked-in MODULE.bazel file matches the one in the extracted and patched source tree.
52+
- Verify the checked-in `MODULE.bazel` file matches the one in the extracted and patched source tree.
5353
- 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`.
5454

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

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

6060
### Anonymous module test

0 commit comments

Comments
 (0)