Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmijatovic/github-ci-demo
Testing github actions
https://github.com/dmijatovic/github-ci-demo
Last synced: 20 days ago
JSON representation
Testing github actions
- Host: GitHub
- URL: https://github.com/dmijatovic/github-ci-demo
- Owner: dmijatovic
- License: apache-2.0
- Created: 2021-09-23T14:16:04.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T14:11:41.000Z (about 2 years ago)
- Last Synced: 2024-11-13T16:54:11.737Z (3 months ago)
- Language: JavaScript
- Size: 1.01 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Github actions and badges
[](https://fair-software.eu)
This repo is testing some github action approaches based on [this Udemy training](https://udemy.com/course/github-actions/learn)
## Features actions
- simple.yml: running some basic shell commands on latest ubuntu
## Leasson lerned
Jobs run in parallel by default. To define sequence/dependencies use `needs`.
## Actions
The actions can be written in Javascript., for some other programming language you can use docker action. It can use from action repo or custom action can be created in the local repository.
When reffering to action you need to specify branch of the repo or version. Version is prefferd as it is more stable than a branch.
### Custom private actions
You can create private action in your project. This action is only available for this project. The custom private actions are stored in ./github/actions folder.
```bash
# install actions packages
npm i -D @actions/core @actions/github
npm i -D @vercel/ncc
```
NOTE! The action will require these modules to run. You can install everything first or you can use @vercel/ncc module to compile the action and have single file that can run in github action.
For more information about core actions [see this repo](https://github.com/actions/toolkit)
## Vue 3 + Typescript + Vite
This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 `` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
### Recommended IDE Setup
- [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)
### Type Support For `.vue` Imports in TS
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's `.vue` type support plugin by running `Volar: Switch TS Plugin on/off` from VSCode command palette.
### Testing
Use vue testing library. NOT AVALIABLE FOR Vue v3
```bash
npm i -D jest @types/jest ts-jest @vue/test-utils@next @vue/vue3-jest
```
## Semantic Release
This tools enables automatic version control and CHANGELOG file generation based on the commit messages. Commit message do need to be in specific format in order to automate this process. For [more info see here](https://github.com/semantic-release/semantic-release/tree/685d2b5455bd55611e0581672a899631f06beb90)
```bash
npm i -D semantic-release
```
### Github action for tagging and CHANGELOG
I expectiemented with github actions to automatically create release.
- TriPSs/conventional-changelog-action@latest: makes changelog and tags release. Have problems triggering major release using BREAKING CHANGES in commit. Use in release-tag-conventional-commits.yml file
- marvinpinto/action-automatic-releases@latest: createds github relase. It is used it on tag push.
### Other action to try
- [GH release](https://github.com/marketplace/actions/gh-release): thisone sounds OK, but not sure how well it fits my needs
- [Release changelog builder](https://github.com/marketplace/actions/release-changelog-builder)
- [Tag changelog](https://github.com/marketplace/actions/tag-changelog): thisone seem atractive to me based on config options
- [Build and push docker image to GHCR](https://github.com/marketplace/actions/build-and-publish-docker-images-to-github-container-registry)
Use [action marketplace to find newones](https://github.com/marketplace?category=publishing&query=sort%3Apopularity-desc&type=actions)
### [TriPSs/conventional-changelog-action](https://github.com/TriPSs/conventional-changelog-action)
This action has number of flexible features:
- skip-commit: to avoid new commit with changelog.md file
- output-file: do not output changelog.md file
- git-push: false does not works as expected. It will create tag but not push it. However if there are steps at the later stage that manipulate content and commit, the tag might be pushed with this changes. I had this during testing.
Triggering breaking change requires using BREAKING CHANGE: what is the change... text in the footer of commit message (new line required).
### [Create release action](softprops/action-gh-release@v1)
## Deleting tags manually
```bash
# delete locally
git tag -d {tag}
# remove from origin
git push origin --delete {tag}
# or more specificaly
git push origin :refs/tags/{tag}
```
## Creating anotated tag manually
When using conventational-changelog-action or same kind of actions to calculate version tag you might want to interfere with the automatic versioning. That is possible by creating anonated tags manually or removing existing tags from the repo.
```bash
# create anotated tag
git tag -a {tag} -m {tag}
# push tags only
git push --tags
# push commits and tags at the same time (not sure this works as exepected)
git push --follow-tags
```
## Github badges
The github bages with the last status of running actions can be created. [Official documentation](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge)
```md
<!-- add workfolow badge, it uses workflow name-->
```
## Check code coverage
To only have a test coverage badge there are few NPM solutions. All are related to javascript testing.
- [jest-code-coverage](https://github.com/pamepeixinho/jest-coverage-badges): makes Jest coverage badges
- [check-code-coverage](https://github.com/bahmutov/check-code-coverage#readme): uses shields.io to create badge.
```md
<!-- manually provide badge -->
```