readme

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contribution Guide
+
+:tada: Thanks for taking the time to contribute! :tada:
+
+The following is a set of guidelines for contributing to this repository, which is hosted in the [Codecov Organization](https://github.com/codecov) on GitHub. 
+
+## What does this repo do?
+
+This repo is a GitHub Action, meaning it integrates with the GitHub Actions CI/CD pipeline. It's meant to take formatted reports with code coverage stats and upload them to codecov.io. What's essentially happening in the background is that Actions is spinning up a Linux Docker container with the contents of this repository. Inside that container, we then call a shell scipt that runs Codecov's Bash uploader. 
+
+## PRs and Support
+
+Feel free to clone, modify code and request a PR to this repository. All PRs will be reviewed by the Codecov team. If your PR has been sitting for a while or if you have any questions, ping us at support@codecov.io 

Dockerfile

@@ -1,3 +1,6 @@
+# Codecov @codecov
+# Ibrahim Ali @ibrahim0814
+
 FROM alpine:3.10
 
 WORKDIR /app

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Codecov
+
+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.

README.md

@@ -1,28 +1,66 @@
-<!-- <p align="center"><img  src="./codecov-logo.png"  /></p> -->
+# Codecov GitHub Action
-
+### Easily upload coverage reports to Codecov from GitHub Actions 
-# Codecov Github Action
-### Easily upload coverage reports to Codecov from Github Actions 
 
 ## Usage
 
+To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number as a `step` within your `workflow.yml` file. This Action also requires you to provide an upload token from [codecov.io](https://www.codecov.io) (tip: in order to avoid exposing your token, store it as a `secret`). Optionally, you can choose to include three additional inputs to customize the upload context.
+
 Inside your `.github/workflows/workflow.yml` file:
 
 ```yaml
 steps:
 - uses: actions/checkout@master
-- uses: actions/codecov-action@v0.1
+- uses: actions/codecov-action@v1
   with:
-    token: ${{secrets.CODECOV_TOKEN}}
+    token: ${{secrets.CODECOV_TOKEN}} #required
+    file: ./coverage.xml #optional
+    flags: unittests #optional
+    name: codecov-umbrella #optional
 ```
->**Note**: This assumes that you've set your Codecov token inside settings > secrets as `CODECOV_TOKEN`. If not, you can get an upload token for your specific repo on codecov.io. A token is not required for public repositories. 
+>**Note**: This assumes that you've set your Codecov token inside *Settings > Secrets* as `CODECOV_TOKEN`. If not, you can get an upload token for your specific repo on [codecov.io](https://www.codecov.io). 
 
 ## Arguments
 
-| Argument  | Description |
+Codecov's Action currently supports four inputs from the user: `token`, `file`, `flags`, and `name`.  These inputs, along with their descriptions and usage contexts, are listed in the table below: 
-| :---:     |     :---:   | 
-| `token`  | Used to authorize coverage report uploads  |
 
+| Input  | Description | Usage |
+| :---:     |     :---:   |    :---:   |
+| `token`  | Used to authorize coverage report uploads  | *Required* |
+| `file`  | Location of the coverage report | Optional
+| `flags`  | Flag upload under a certain group | Optional
+| `name`  | Custom defined name for the upload | Optional
+
+### Example `workflow.yml` with Codecov Action
+
+```yaml
+name: Example workflow for Codecov
+on: [push]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python  
+      uses: actions/setup-python@master
+      with:
+        version: 3.7
+    - name: Generate coverage report
+      run: |
+        pip install pytest
+        pip install pytest-cov
+        pytest --cov=./ --cov-report=xml
+    - name: Upload coverage to Codecov  
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{secrets.CODECOV_TOKEN}}
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella 
+```
+## Contributing
+
+Contributions are welcome! Check out the [Contribution Guide](CONTRIBUTING.md).
 
 ## License 
 
-The code in this project is released under the MIT License
+The code in this project is released under the [MIT License](LICENSE).

action.yml

@@ -1,10 +1,19 @@
 name: 'Codecov'
-description: 'Github action that uploads coverage reports for your repository to codecov.io'
+description: 'GitHub Action that uploads coverage reports for your repository to codecov.io'
-author: 'Ib @ Codecov'
+author: 'Ibrahim Ali <@ibrahim0814> | Codecov'
 inputs: 
-  token:
+  name:
-    description: 'Set the repository token'
+    description: 'User defined upload name. Visible in Codecov UI'
     required: false 
+  token:
+    description: 'Repository upload token - get it from codecov.io'
+    required: false 
+  file:
+    description: 'Path to coverage file to upload'
+    required: false
+  flags:
+    description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)'
+    required: false
 branding:
   color: 'red' 
   icon: 'umbrella'
@@ -12,4 +21,8 @@ runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
+    - ${{ inputs.name }}
     - ${{ inputs.token }}
+    - ${{ inputs.file }}
+    - ${{ inputs.flags }}
+   

entrypoint.sh

@@ -1,11 +1,59 @@
 #!/bin/bash
 
+# Codecov @codecov
+# Ibrahim Ali @ibrahim0814
+
 set -eu
 
 if [ $# -eq 0 ]
-  then
+then
-    bash <(curl -s https://codecov.io/bash)
+  bash <(curl -s https://codecov.io/bash)
+elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_FILE" != "x" ] && [ "x$INPUT_FLAGS" != "x" ] && [ "x$INPUT_NAME" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -f $INPUT_FILE -F $INPUT_FLAGS -n $INPUT_NAME
+elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_FILE" != "x" ] && [ "x$INPUT_FLAGS" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -f $INPUT_FILE -F $INPUT_FLAGS
+elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_FILE" != "x" ] && [ "x$INPUT_NAME" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -f $INPUT_FILE -n $INPUT_NAME
+elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_NAME" != "x" ] && [ "x$INPUT_FLAGS" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -n $INPUT_NAME -F $INPUT_FLAGS
+elif [ "x$INPUT_NAME" != "x" ] && [ "x$INPUT_FILE" != "x" ] && [ "x$INPUT_FLAGS" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -n $INPUT_NAME -f $INPUT_FILE -F $INPUT_FLAGS
+elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_FILE" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -f $INPUT_FILE
+elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_FLAGS" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -F $INPUT_FLAGS
+elif [ "x$INPUT_FLAGS" != "x" ] && [ "x$INPUT_FILE" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -F $INPUT_FLAGS -f $INPUT_FILE
+elif [ "x$INPUT_FLAGS" != "x" ] && [ "x$INPUT_NAME" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -F $INPUT_FLAGS -n $INPUT_NAME
+elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_NAME" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -n $INPUT_NAME
+elif [ "x$INPUT_FILE" != "x" ] && [ "x$INPUT_NAME" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -f $INPUT_FILE -n $INPUT_NAME
+elif [ "x$INPUT_TOKEN" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN
+elif [ "x$INPUT_FILE" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -f $INPUT_FILE
+elif [ "x$INPUT_FLAGS" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -F $INPUT_FLAGS
+elif [ "x$INPUT_NAME" != "x" ]
+then
+  bash <(curl -s https://codecov.io/bash) -n $INPUT_NAME
 else
-  bash <(curl -s https://codecov.io/bash) -t $1
+  echo "error"
-fi
+  exit 1
-
+fi