Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xlayers/version-stamp
An easy way to version stamp your Angular applications and libraries
https://github.com/xlayers/version-stamp
angular release-automation stamp stamp-component typescript version
Last synced: about 1 month ago
JSON representation
An easy way to version stamp your Angular applications and libraries
- Host: GitHub
- URL: https://github.com/xlayers/version-stamp
- Owner: xlayers
- License: apache-2.0
- Created: 2020-10-12T10:53:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-17T20:15:11.000Z (almost 4 years ago)
- Last Synced: 2024-02-24T17:34:43.543Z (10 months ago)
- Topics: angular, release-automation, stamp, stamp-component, typescript, version
- Language: TypeScript
- Homepage: https://xlayers.dev
- Size: 1.21 MB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Welcome to xLayers version-stamp
## What is xLayers version-stamp?
With xLayers version-stamp we've started a new initiative of providing a community-driven way of version stamping that will help on a daily base for everybody!
The xLayers projects are driven by community contributions. Please send us your Pull Requests and feedback!
## Quick start
1. Add `@xlayers/version-stamp` to your project
```sh
ng add @xlayers/version-stamp
```
2. The package will make some small changes to the `angular.json`
3. Add the following snippet (only the version property) to your environment files.
```ts
export const environment = {
production: false,
version: '_BUILD_HASH_',
};
```
4. Use the version that the packages has provided in your `environment` properties.
````ts
import { environment } from '../environment'
```
```ts
@Component({
selector: 'xlayers-builders-root',
})
export class AppComponent {
version = environment.version;
}
```
5. Now you can stamp your build
```sh
ng run :stamp
````
## Usage
You can adjust some options to your needs.
The available options are:
- `--version` - You can put in here your own version.
Example:
```sh
ng run :stamp --version="1.0.0"
```
- `--files` - You can put in here the list of file patterns containing `_BUILD_HASH_`
Example:
```sh
ng run :stamp --files=*.js,*.json
```
You can also set the configuration in `angular.json`
```json
"stamp": {
"builder": "@xlayers/version-stamp:stamp",
"options": {
"outputPath": "dist/packages/demo",
"files": ["*.js", "*.json"]
}
}
```
## Want to help? [](https://github.com/xlayers/version-stamp/issues)
Want to file a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for [contributing](https://github.com/xlayers/version-stamp/blob/main/CONTRIBUTING.md) and then check out one of our issues in the hotlist: [community-help](https://github.com/xlayers/version-stamp/issues).
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/xlayers#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/xlayers#sponsor)]
[
](https://www.centigrade.de/en)
