Skip to content

Commit

Permalink
🚀 Upload main badges (#1)
Browse files Browse the repository at this point in the history
* add action

* remove envs

* modify docs

* modify text
  • Loading branch information
rahulpatidar0191 authored Nov 14, 2023
1 parent c17539c commit 8161e73
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 1 deletion.
Empty file added .gitignore
Empty file.
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @rahulpatidar0191
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Satel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
# satel-upload-main-badges
# Satel Upload Main Badges

This centralized GitHub action uploads the main coverage badges on the server

### Usage

```yml
upload-main-badge:
needs: [poetry-redoc, generate-badges]
timeout-minutes: 10
if: ${{ github.ref != 'refs/heads/main' }}
runs-on: samba
environment: ${{ inputs.environment }}
env:
BADGE: ${{ needs.generate-badges.outputs.BADGE }}
steps:
- name: upload-main-badge
uses: SatelCreative/satel-upload-main-badges@1.0.0
with:
app-name: ${{ inputs.app-name }}
badge: "${{ env.BADGE }}"

```
22 changes: 22 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Copy badges to server
description: To copy badges to server
inputs:
app-name:
description: Name of the App
required: true
badge:
description: Badge for main branch
required: true

runs:
using: "composite"
steps:
- name: Check out repository
uses: actions/checkout@v4.1.1

- name: Copy badge to server
shell: bash
run: |
REPO_NAME="${{ github.event.repository.name }}"
rm /mnt/samba/$REPO_NAME/${{ inputs.app-name }}-main.svg 2> /dev/null || true # to avoid permissions issue, remove main files first
curl -L "${{ inputs.badge }}" -o "/mnt/samba/$REPO_NAME/${{ inputs.app-name }}-main.svg"

0 comments on commit 8161e73

Please sign in to comment.