Skip to content

Commit

Permalink
tweak doc, scripts for release
Browse files Browse the repository at this point in the history
Signed-off-by: Terence Parr <[email protected]>
  • Loading branch information
parrt committed Apr 11, 2022
1 parent 2471728 commit e37fea1
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 9 deletions.
29 changes: 26 additions & 3 deletions doc/releasing-antlr.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ Then run the usual python set up stuff:
```bash
cd ~/antlr/code/antlr4/runtime/Python2
# assume you have ~/.pypirc set up
python2 setup.py sdist upload
python setup.py sdist upload
```

and do again for Python 3 target
Expand Down Expand Up @@ -426,6 +426,8 @@ popd

### Dart

*Looks like only [Lingyu.li](https://pub.dev/publishers/lingyu.li/packages) can install*

Install Dart SDK from https://dart.dev/get-dart

Push to pub.dev
Expand Down Expand Up @@ -459,7 +461,27 @@ Copy javadoc and java jars to website using this script:

```bash
cd ~/antlr/code/antlr4
python scripts/deploy.py 4.9.3 4.10
python scripts/deploy_to_website.py 4.9.3 4.10
```

Output:

```bash
Updating ANTLR version from 4.9.3 to 4.10
Set ANTLR website root (default /Users/parrt/antlr/sites/website-antlr4):
Version string updated. Please commit/push:
Javadoc copied:
api/Java updated from antlr4-runtime-4.10-javadoc.jar
api/JavaTool updated from antlr4-4.10-javadoc.jar
Jars copied:
antlr-4.10-complete.jar
antlr-runtime-4.10.jar

Please look for and add new api files!!
Then MANUALLY commit/push:

git commit -a -m 'Update website, javadoc, jars to 4.10'
git push origin gh-pages
```

<!--
Expand All @@ -475,7 +497,8 @@ git add antlr-runtime-4.10.jar
Once it's done, you must do the following manually:

```
git commit -a -m 'add 4.10 jars'
cd ~/antlr/sites/website-antlr4
git commit -a -m 'Update website, javadoc, jars to 4.10'
git push origin gh-pages
```

Expand Down
12 changes: 6 additions & 6 deletions runtime/JavaScript/package-lock.json

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

4 changes: 4 additions & 0 deletions scripts/deploy.py → scripts/deploy_to_website.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ def copy_javadoc(release_version):
os.chdir(WEBSITE_ROOT+"/api/JavaTool")
runme(f"jar xf {ANTLR_M2_ROOT}/antlr4/{release_version}/antlr4-{release_version}-javadoc.jar")
print(f"\tapi/JavaTool updated from antlr4-{release_version}-javadoc.jar")
os.chdir(WEBSITE_ROOT+"/api/maven-plugin/latest")
runme(f"jar xf {ANTLR_M2_ROOT}/antlr4-maven-plugin/{release_version}/antlr4-maven-plugin-{release_version}-javadoc.jar")
print(f"\tapi/JavaTool updated from antlr4-maven-plugin-{release_version}-javadoc.jar")


def copy_jars(release_version):
Expand Down Expand Up @@ -87,5 +90,6 @@ def update_version():
print("Please look for and add new api files!!")
print("Then MANUALLY commit/push:")
print()
print(f"cd {WEBSITE_ROOT}")
print(f"git commit -a -m 'Update website, javadoc, jars to {after}'")
print("git push origin gh-pages")

0 comments on commit e37fea1

Please sign in to comment.