Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/udondan/jsii-publish
Dockerfile and Github action for publishing JSII packages
https://github.com/udondan/jsii-publish
Last synced: about 2 months ago
JSON representation
Dockerfile and Github action for publishing JSII packages
- Host: GitHub
- URL: https://github.com/udondan/jsii-publish
- Owner: udondan
- License: mit
- Archived: true
- Created: 2019-12-18T15:15:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-19T08:03:22.000Z (over 1 year ago)
- Last Synced: 2024-05-07T15:21:52.158Z (about 2 months ago)
- Language: Shell
- Homepage:
- Size: 146 KB
- Stars: 18
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-cdk - jsii-publish - A [Docker image](https://hub.docker.com/r/udondan/jsii-publish) and [GitHub action](https://github.com/marketplace/actions/jsii-publish) to build and publish CDK constructs created via [JSII](https://github.com/aws/jsii). (Library Publishing / Multi-accounts setup)
- awesome-cdk - jsii-publish - publish) and [GitHub action](https://github.com/marketplace/actions/jsii-publish) to build and publish CDK constructs created via [JSII](https://github.com/aws/jsii). (Tools)
README
# Dockerfile and GitHub action for publishing JSII packages
**DEPRECATED: Please use [publib](https://github.com/cdklabs/publib)**
[][releases]
[][hub]
[][hub-builds]
[][hub]
[][MITlicense]
Package building and publishing to npm, PyPI, NuGet and Maven (GitHub).
## Examples
### GitHub workflow
```yml
---
name: Publish packages
on:
push:
tags:
- "v*"
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Get the version
id: get_version
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\/v/}
- name: Checkout code
uses: actions/checkout@v1
with:
fetch-depth: 1
- name: Publish packages
uses: udondan/[email protected]
with:
VERSION: ${{ steps.get_version.outputs.VERSION }}
BUILD_SOURCE: true
BUILD_PACKAGES: true
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_REPOSITORY: ${{ github.repository }}
```
In above example all actions are executed in the same step. You as well can split the actions into separate steps like so:
```yml
---
name: Publish packages
on:
push:
tags:
- "v*"
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Get the version
id: get_version
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\/v/}
- name: Checkout code
uses: actions/checkout@v1
with:
fetch-depth: 1
- name: Build source
uses: udondan/[email protected]
with:
VERSION: ${{ steps.get_version.outputs.VERSION }}
BUILD_SOURCE: true
- name: Build packages
uses: udondan/[email protected]
with:
BUILD_PACKAGES: true
- name: Publish to npm
uses: udondan/[email protected]
with:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Publish to PyPI
uses: udondan/[email protected]
with:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
- name: Publish to NuGet
uses: udondan/[email protected]
with:
NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
- name: Publish to Maven GitHub
uses: udondan/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_REPOSITORY: ${{ github.repository }}
```
### Running the Docker image locally
```bash
docker run -it \
--workdir /workdir \
--volume $(pwd):/workdir \
--env VERSION=0.3.0 \
--env BUILD_SOURCE=true \
--env BUILD_PACKAGES=true \
--env NPM_TOKEN \
--env PYPI_TOKEN \
--env NUGET_TOKEN \
--env GITHUB_TOKEN \
--env GITHUB_REPOSITORY="${OWNER}/${REPOSITORY}" \
udondan/jsii-publish:0.14.0
```
The package code can be mounted to any location in the container. Just make sure you set the workdir to the same value. In the example above I use `/workdir`.
Parameters passed per env:
- **VERSION**: If set, the version in `package.json` will be updated with this value
- **BUILD_SOURCE**: If `true`, the source will be compiled from TS to JS
- **BUILD_PACKAGES**: If `true`, all configured JSII packages will be built
- **CLEANUP**: If `true`, deletes the dist directory after publishing
- **NPM_TOKEN**: Your publish token for npm. If passed, package will be published to npm
- **PYPI_TOKEN**: Your publish token for PyPI. If passed, package will be published to PyPI
- **NUGET_TOKEN**: Your publish token for NuGet. If passed, package will be published to NuGet
- **GITHUB_TOKEN**: The token to interact with GitHub. If passed, the Maven package will be published to GitHub packages.
If you run the GitHub action, the token will be automatically be generated byu GitHub and is available as `${{ GITHUB_TOKEN }}`. If you run the Docker image yourself, you need to pass in a [personal access token](https://github.com/settings/tokens) with `read:packages` and `write:packages` capabilities.
- **GITHUB_REPOSITORY**: The url slug of your repository, which is `${OWNER}/${REPOSITORY}`. In a github action you can just pass `${{ github.repository }}`
- **DEBUG**: If `true`, debug mode is enabled. **Might leak secrets in output**
- **NPM_OPTIONS**: Command options to append to the `npm publish` command
- **PYPI_OPTIONS**: Command options to append to the `twine upload` command
- **NUGET_OPTIONS**: Command options to append to the `dotnet nuget push` command
## License
The project is licensed under [MIT][MITlicense].
[hub]: https://hub.docker.com/r/udondan/jsii-publish
[hub-builds]: https://hub.docker.com/r/udondan/jsii-publish/builds
[releases]: https://github.com/udondan/jsii-publish/releases
[MITlicense]: https://github.com/udondan/jsii-publish/blob/master/LICENSE