summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDarius Jahandarie <djahandarie@gmail.com>2023-09-23 18:05:33 +0900
committerDarius Jahandarie <djahandarie@gmail.com>2023-09-23 23:18:52 +0900
commit6f24ac4e2a1ee8928e0be69bea774bcade28f2a9 (patch)
tree0f3cdca6bef987b55559a166fa55cb79fa13598b /CONTRIBUTING.md
parent94ccff4c790ae8c2ef301bdb4e593f51436b3c8e (diff)
Remove hardcoded version from manifest
* Dynamically set version as argument to build script * Set version using tag ref_name in CI * [Cleanup] gitignore ext/manifest.json as it's dynamically generated
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 4 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ffc76b74..b67f6092 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -50,9 +50,10 @@ Several command line arguments are available for these scripts:
* `[target]` - Builds a specific target.
* `--all` - Builds all targets specified in [manifest-variants.json](dev/data/manifest-variants.json).
* `--default` - Restores the default manifest file.
-* `--manifest <target>` - Overwrites [ext/manifest.json](ext/manifest.json) with the manifest variant for the specified build target.
+* `--manifest <target>` - Overwrites `ext/manifest.json` with the manifest variant for the specified build target.
* `--dry-run` - Runs the full build process (excluding zip building), checking that the configuration is valid.
* `--dry-run-build-zip` - If `--dry-run` is also specified, zip building will also be performed in memory; no files are created.
+* `--yomitan-version <version>` - Sets the version number in the extension manifest. Defaults to 0.0.0.0 if not set.
If no arguments are specified, the command is equivalent to `build.bat --all`.
@@ -66,11 +67,8 @@ Otherwise, the [JSZip](https://stuk.github.io/jszip/) API is used to generate th
## Manifest
Manifest variants for different build targets are specified in [manifest-variants.json](dev/data/manifest-variants.json).
-This file is used to overwrite the [manfiest.json](ext/manifest.json) file included in the extension.
-By default, this manifest should be the default `chrome` manifest, and changes to [manfiest.json](ext/manifest.json) should not be committed
-unless there is a corresponding change in [manifest-variants.json](dev/data/manifest-variants.json).
-There is a continuous integration test which validates this, and the default manifest can be restored by running
-`build.bat --default`.
+This file is used to generate the `ext/manifest.json` file included in the extension.
+The generated `ext/manfiest.json` should not be committed.
## Style