assets typo

Update Action Name

Dockerfile

@@ -1,11 +1,12 @@
-# Using CentOS 7 with Node 12 as base image to support rpmbuild
+# Using CentOS 7 as base image to support rpmbuild (packages will be Dist el7)
 FROM centos:7
 
 # Copying all contents of rpmbuild repo inside container
 COPY . .
 
-# Installing tools needed for rpmbuild , depends on specfile
-RUN yum install -y rpm-build rpmdevtools gcc make coreutils
+# Installing tools needed for rpmbuild , 
+# depends on BuildRequires field in specfile, (TODO: take as input & install)
+RUN yum install -y rpm-build rpmdevtools gcc make coreutils python
 
 # Setting up node to run our JS file
 # Download Node Linux binary

README.md

@@ -8,15 +8,12 @@ Integrates easily with GitHub actions to allow RPMS to be uploaded as Artifact (
 ### Pre-requisites
 Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow---build-rpm) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file). 
 
-This generated RPMS and SRPMS can be used in two ways.
-1. Upload as build artifact
-    You can use GitHub Action [`@actions/upload-artifact`](https://www.github.com/actions/upload-artifact)
-2. Upload as Release assest 
-    If you want to upload as release asset ,You also will need to have a release to upload your asset to, which could be created programmatically by [`@actions/create-release`](https://www.github.com/actions/create-release) as show in the example workflow.
+**Note:** You need to have a spec file in order to build RPM.
+
 
 ### Inputs
 
-- `spec_file`: The path to the spec file in your repo. `**require**`
+- `spec_file`: The path to the spec file in your repo. [**required**]
 
 ### Outputs
 
@@ -26,6 +23,11 @@ This generated RPMS and SRPMS can be used in two ways.
 - `source_rpm_name`: name of Source RPM file
 - `rpm_content_type`: Content-type for RPM Upload
 
+This generated RPMS and SRPMS can be used in two ways.
+1. Upload as build artifact
+    You can use GitHub Action [`@actions/upload-artifact`](https://www.github.com/actions/upload-artifact)
+2. Upload as Release assest 
+    If you want to upload as release asset ,You also will need to have a release to upload your asset to, which could be created programmatically by [`@actions/create-release`](https://www.github.com/actions/create-release) as show in the example workflow.
 
 ### Example workflow - build RPM
 
@@ -49,10 +51,97 @@ jobs:
     - name: Upload artifact
       uses: actions/upload-artifact@v1.0.0
       with:
-        name: Source RPM
-        path: ${{ steps.rpm.outputs.source_rpm_path }}
+        name: Binary RPM
+        path: ${{ steps.rpm.outputs.rpm_dir_path }}
 ```
+This workflow triggered on every `push` , builds RPM and Source RPM using cello.spec and contents of that git ref that triggered that action. Contents are retrived through [GitHub API](https://developer.github.com/v3/repos/contents/#get-archive-link) [downloaded through archive link].  
+The generated RPMs or SRPMS can be uploaded as artifacts by using actions/upload-artifact. The [outputs](#outputs) given by rpmbuild action can be used to specify path for upload action.
+
+#### Above workflow will create an artifact like :
+
+![artifact_image](assets/upload_artifacts.png)
+
+
+Use with Release:
+```yaml
+on:
+    push:
+      # Sequence of patterns matched against refs/tags
+      tags:
+        - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+  
+name: Create RPM Release
+
+jobs:
+    build:
+        name: Create RPM Release
+        runs-on: ubuntu-latest
+
+        steps:
+
+        - name: Checkout code
+          uses: actions/checkout@master
+
+        - name: Create Release
+          id: create_release
+          uses: actions/create-release@latest
+          env:
+              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+          with:
+              tag_name: ${{ github.ref }}
+              release_name: Release ${{ github.ref }}
+              body: |
+                Changes in this Release
+                - Create RPM
+                - Upload Source RPM
+              draft: false
+              prerelease: false
+            
+        - name: build RPM package
+          id: rpm_build
+          uses: naveenrajm7/rpmbuild@master
+          with:
+              spec_file: "cello.spec"
+            
+        - name: Upload Release Asset
+          id: upload-release-asset 
+          uses: actions/upload-release-asset@v1
+          env:
+              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          with:
+              upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps 
+              asset_path: ${{ steps.rpm_build.outputs.source_rpm_path }}
+              asset_name: ${{ steps.rpm_build.outputs.source_rpm_name }}
+              asset_content_type: ${{ steps.rpm_build.outputs.rpm_content_type }}
+```
+
+#### The above release uploads SRPM like :
+
+![artifact_image](assets/upload_release_asset.png)
+
+Example Repository which uses rpmbuild action https://github.com/naveenrajm7/cello
+
+Note on distribution:
+If your RPMs are distribution specific like el7 or el8.  
+- Use naveenrajm7/rpmbuild@master for Centos7 *[el7]*
+- Use naveenrajm7/rpmbuild@centos8 for Centos8 *[el8]*
+
+```yaml
+- name: build RPM package
+    id: rpm_build
+    uses: naveenrajm7/rpmbuild@centos8
+    with:
+        spec_file: "cello.spec"
+```
+
+## References
+
+* [RPM Packaging Guide](https://rpm-packaging-guide.github.io/)
+* [GitHub Learning Lab](https://lab.github.com/)
+* [Container Toolkit Action](https://github.com/actions/container-toolkit-action)
 
 ## License
 
 The scripts and documentation in this project are released under the [GNU GPLv3](LICENSE)
+
+*Created during the GitHub Actions Hackathon 2020 :octocat: :computer: .*

action.yml

@@ -12,9 +12,11 @@ outputs:
   source_rpm_path:
     description: 'path to Source RPM file'
   source_rpm_dir_path:
-    description: 'path to Source RPM directory'
+    description: 'path to  SRPMS directory'
   source_rpm_name:
     description: 'name of Source RPM file'
+  rpm_dir_path:
+    description: 'path to RPMS directory'
   rpm_content_type:
     description: 'Content-type for Upload'
 

lib/main.js

@@ -19,6 +19,7 @@ function run() {
         try {
             // Get github context data
             const context = github.context;
+            // To be used to get contents of this git ref 
             const owner = context.repo.owner;
             const repo = context.repo.repo;
             const ref = context.ref;
@@ -44,29 +45,30 @@ function run() {
             yield exec.exec('rpmdev-setuptree');
             // Copy spec file from path specFile to /root/rpmbuild/SPECS/
             yield exec.exec(`cp /github/workspace/${specFile} /github/home/rpmbuild/SPECS/`);
-            // Dowload tar.gz file of source code
+            // Dowload tar.gz file of source code,  Reference : https://developer.github.com/v3/repos/contents/#get-archive-link
             yield exec.exec(`curl -L --output tmp.tar.gz https://api.github.com/repos/${owner}/${repo}/tarball/${ref}`);
-            // create directory to match source file - name-version
+            // create directory to match source file - %{name}-{version}.tar.gz of spec file
             yield exec.exec(`mkdir ${name}-${version}`);
-            // Extract source code to directory
+            // Extract source code 
             yield exec.exec(`tar xvf tmp.tar.gz -C ${name}-${version} --strip-components 1`);
             // Create Source tar.gz file 
             yield exec.exec(`tar -czvf ${name}-${version}.tar.gz ${name}-${version}`);
-            // Get repo files from /github/workspace/
-            yield exec.exec('ls -la ');
-            // Copy tar.gz file to source
+            // // list files in current directory /github/workspace/
+            // await exec.exec('ls -la ');
+            // Copy tar.gz file to source path
             yield exec.exec(`cp ${name}-${version}.tar.gz /github/home/rpmbuild/SOURCES/`);
-            // Execute rpmbuild 
+            // Execute rpmbuild , -ba generates both RPMS and SPRMS
             try {
                 yield exec.exec(`rpmbuild -ba /github/home/rpmbuild/SPECS/${specFile}`);
             }
             catch (err) {
                 core.setFailed(`action failed with error: ${err}`);
             }
-            // Verify RPM created
+            // Verify RPM is created
             yield exec.exec('ls /github/home/rpmbuild/RPMS');
             // setOutput rpm_path to /root/rpmbuild/RPMS , to be consumed by other actions like 
             // actions/upload-release-asset 
+            // Get source rpm name , to provide file name, path as output
             let myOutput = '';
             yield cp.exec('ls /github/home/rpmbuild/SRPMS/', (err, stdout, stderr) => {
                 if (err) {
@@ -81,14 +83,14 @@ function run() {
                 }
             });
             // only contents of workspace can be changed by actions and used by subsequent actions 
-            // So copy all generated rpms into workspace , and publish output path relative to workspace
+            // So copy all generated rpms into workspace , and publish output path relative to workspace (/github/workspace)
             yield exec.exec(`mkdir -p rpmbuild/SRPMS`);
             yield exec.exec(`mkdir -p rpmbuild/RPMS`);
             yield exec.exec(`cp /github/home/rpmbuild/SRPMS/${myOutput} rpmbuild/SRPMS`);
             yield cp.exec(`cp -R /github/home/rpmbuild/RPMS/. rpmbuild/RPMS/`);
             yield exec.exec(`ls -la rpmbuild/SRPMS`);
             yield exec.exec(`ls -la rpmbuild/RPMS`);
-            // set output to path relative to workspace ex ./rpm/
+            // set outputs to path relative to workspace ex ./rpmbuild/
             core.setOutput("source_rpm_dir_path", `rpmbuild/SRPMS/`); // path to  SRPMS directory
             core.setOutput("source_rpm_path", `rpmbuild/SRPMS/${myOutput}`); // path to Source RPM file
             core.setOutput("source_rpm_name", `${myOutput}`); // name of Source RPM file

src/download-release-archive.ts

@@ -1,43 +0,0 @@
-const { Octokit } = require('@octokit/rest');
-//const fs = require('fs');
-const tc = require('@actions/tool-cache');
-
-
-async function download_archive(owner, repo, ref ) {
-    try {
-        
-        const octokit = new Octokit();
-
-        const archive_format = "tarball";
-
-        const tag = "v1.0.0"
-        
-        const tarFile = `${repo}-1.0.tar.gz`;
-
-        console.log("Calling API ...");
-        await octokit.repos.getArchiveLink({
-            owner,
-            repo,
-            archive_format,
-            ref
-        }).then(( { data }) => {
-                fs.writeFile(tarFile, Buffer.from(data), function(err){
-                if(err) {
-                    return console.log(err);
-                }
-                console.log("The Tar file was saved!");
-                console.log(`Tarball Location : ${tarFile}`);
-                return tarFile;
-            });
-        }).catch( function(error){
-            console.log(error);
-        });
-
-        
-
-    } catch (error) {
-        core.setFailed(error.message);
-    }
-}
-
-module.exports = download_archive;

src/main.ts

@@ -11,6 +11,7 @@ async function run() {
     // Get github context data
     const context = github.context;
 
+    // To be used to get contents of this git ref 
     const owner = context.repo.owner
     const repo = context.repo.repo
     const ref = context.ref
@@ -42,24 +43,25 @@ async function run() {
     // Copy spec file from path specFile to /root/rpmbuild/SPECS/
     await exec.exec(`cp /github/workspace/${specFile} /github/home/rpmbuild/SPECS/`);
 
-    // Dowload tar.gz file of source code
+    // Dowload tar.gz file of source code,  Reference : https://developer.github.com/v3/repos/contents/#get-archive-link
     await exec.exec(`curl -L --output tmp.tar.gz https://api.github.com/repos/${owner}/${repo}/tarball/${ref}`)
 
-    // create directory to match source file - name-version
+    // create directory to match source file - %{name}-{version}.tar.gz of spec file
     await exec.exec(`mkdir ${name}-${version}`);
 
-    // Extract source code to directory
+    // Extract source code 
     await exec.exec(`tar xvf tmp.tar.gz -C ${name}-${version} --strip-components 1`);
 
     // Create Source tar.gz file 
     await exec.exec(`tar -czvf ${name}-${version}.tar.gz ${name}-${version}`);
 
-    // Get repo files from /github/workspace/
-    await exec.exec('ls -la ');
-    // Copy tar.gz file to source
+    // // list files in current directory /github/workspace/
+    // await exec.exec('ls -la ');
+
+    // Copy tar.gz file to source path
     await exec.exec(`cp ${name}-${version}.tar.gz /github/home/rpmbuild/SOURCES/`);
 
-    // Execute rpmbuild 
+    // Execute rpmbuild , -ba generates both RPMS and SPRMS
     try {
       await exec.exec(
         `rpmbuild -ba /github/home/rpmbuild/SPECS/${specFile}`
@@ -68,12 +70,13 @@ async function run() {
       core.setFailed(`action failed with error: ${err}`);
     }
 
-    // Verify RPM created
+    // Verify RPM is created
     await exec.exec('ls /github/home/rpmbuild/RPMS');
 
     // setOutput rpm_path to /root/rpmbuild/RPMS , to be consumed by other actions like 
     // actions/upload-release-asset 
 
+    // Get source rpm name , to provide file name, path as output
     let myOutput = '';
     await cp.exec('ls /github/home/rpmbuild/SRPMS/', (err, stdout, stderr) => {
       if (err) {
@@ -89,7 +92,7 @@ async function run() {
 
 
     // only contents of workspace can be changed by actions and used by subsequent actions 
-    // So copy all generated rpms into workspace , and publish output path relative to workspace
+    // So copy all generated rpms into workspace , and publish output path relative to workspace (/github/workspace)
     await exec.exec(`mkdir -p rpmbuild/SRPMS`);
     await exec.exec(`mkdir -p rpmbuild/RPMS`);
 
@@ -99,13 +102,11 @@ async function run() {
     await exec.exec(`ls -la rpmbuild/SRPMS`);
     await exec.exec(`ls -la rpmbuild/RPMS`);
     
-    // set output to path relative to workspace ex ./rpm/
+    // set outputs to path relative to workspace ex ./rpmbuild/
     core.setOutput("source_rpm_dir_path", `rpmbuild/SRPMS/`);              // path to  SRPMS directory
     core.setOutput("source_rpm_path", `rpmbuild/SRPMS/${myOutput}`);       // path to Source RPM file
     core.setOutput("source_rpm_name", `${myOutput}`);                      // name of Source RPM file
-
     core.setOutput("rpm_dir_path", `rpmbuild/RPMS/`);                      // path to RPMS directory
-
     core.setOutput("rpm_content_type", "application/octet-stream");        // Content-type for Upload