Enhancement: Add a simple workflow to get started with GitHub Actions #27

localheinz · 2020-08-03T06:36:11Z

This PR

adds a very simple workflow to get started with GitHub Actions

💁‍♂️ This is part 1 of a series of pull requests, as suggested here:

localheinz

As you can see in the Checks tab, a workflow has not been triggered.

This is because the workflow was added from a fork, and a workflow does not exist in the repository yet.

In case you accept this pull request, a workflow will run on the merge commit. Subsequent changes to the workflow will have an effect once the workflow is available in the default branch.

You can see the workflow running in my fork.

localheinz · 2020-08-03T06:36:39Z

.gitattributes

@@ -1,5 +1,6 @@
+/.github export-ignore


Adding .github here because users of this package probably do not need the contents of the .github directory.

localheinz · 2020-08-03T06:37:53Z

.github/workflows/build.yaml

@@ -0,0 +1,19 @@
+# https://docs.github.com/en/actions


Adding a reference to the GitHub Actions documentation here so anyone making changes to the workflow file can easily look it up.

localheinz · 2020-08-03T06:39:55Z

.github/workflows/build.yaml

@@ -0,0 +1,19 @@
+# https://docs.github.com/en/actions
+
+name: Build


This is the name of the workflow as it will appear in the GitHub UI:

in the Actions tab of the repository

in the Checks tab for the pull request

in the list of status checks for a pull request

The name used here will also need to be used when linking to a status badge (see README.md below).

💁‍♂️ For reference, see

https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-status-checks

https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#adding-a-workflow-status-badge-to-your-repository

localheinz · 2020-08-03T06:42:11Z

.github/workflows/build.yaml

+
+name: Build
+
+on:


Using on we can configure a list of events that can trigger a workflow.

💁‍♂️ For reference, see

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#on

https://docs.github.com/en/articles/events-that-trigger-workflows

localheinz · 2020-08-03T06:46:07Z

.github/workflows/build.yaml

+name: Build
+
+on:
+  pull_request: null


Listing pull_request here so we run the workflow on default pull_request events.

These events include:

opened (a pull request was opened)

reopened (a pull request was reopened)

synchronize (one or more commits have been pushed into the corresponding branch)

💁‍♂️ For reference, see

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags

https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request

localheinz · 2020-08-03T06:54:32Z

.github/workflows/build.yaml

+  hello:
+    name: Hello
+
+    runs-on: ubuntu-latest


Using runs-on we can specify the system on which the job should run.

The system can be one of:

ubuntu-16.04

ubuntu-18.04 (or ubuntu-latest)

ubuntu-20.04

ubuntu-latest (or ubuntu-18.04)

macos-10.15 (or macos-latest)

macos-latest (or macos-10.15)

windows-2019 (or windows-latest)

windows-latest (or windows-2019)

💁‍♂️ For reference, see

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on

localheinz · 2020-08-03T06:55:21Z

.github/workflows/build.yaml

+
+    runs-on: ubuntu-latest
+
+    steps:


Each job consists of a series of steps. Every job needs to have at least one step.

💁‍♂️ For reference, see

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsteps

localheinz · 2020-08-03T06:56:32Z

.github/workflows/build.yaml

+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Echo a greeting


A job can have a name, which will then be displayed in the output of the workflow run. The name can be omitted.

It is possible to use variables in the name, they will then be expanded (more on that later).

💁‍♂️ For reference, see

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idname

localheinz · 2020-08-03T06:58:32Z

.github/workflows/build.yaml

+
+    steps:
+      - name: Echo a greeting
+        run: echo 'Hello, GitHub Actions!'


A job can have a run or a uses directive.

With the run directive we can configure one or more commands to run on the command line.

💁‍♂️ For reference, see

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses

localheinz · 2020-08-03T07:00:51Z

README.md

@@ -1,6 +1,7 @@
 # Version

 [![Build Status](https://travis-ci.com/nikolaposa/version.svg?branch=master)](https://travis-ci.com/nikolaposa/version)
+[![Build](/~https://github.com/nikolaposa/version/workflows/Build/badge.svg?branch=master)](/~https://github.com/nikolaposa/version/actions)


Adding a badge here.

Note that Build in the URL refers to the name of the workflow. When the name of the workflow contained spaces, they would need to be URL-encoded.

For example:

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 958cb47..aa1a9dc 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,6 +1,6 @@ # https://docs.github.com/en/actions -name: Build +name: Continuous Integration on: pull_request: null diff --git a/README.md b/README.md index 7ed172e..f4d7ca8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Version [![Build Status](https://travis-ci.com/nikolaposa/version.svg?branch=master)](https://travis-ci.com/nikolaposa/version) -[![Build](/~https://github.com/nikolaposa/version/workflows/Build/badge.svg?branch=master)](/~https://github.com/nikolaposa/version/actions) +[![Build](/~https://github.com/nikolaposa/version/workflows/Continous%20Integration/badge.svg?branch=master)](/~https://github.com/nikolaposa/version/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nikolaposa/version/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nikolaposa/version/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/nikolaposa/version/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/nikolaposa/version/?branch=master) [![Latest Stable Version](https://poser.pugx.org/nikolaposa/version/v/stable)](https://packagist.org/packages/nikolaposa/version)

nikolaposa

I like where this is going, thank you very much for willing to contribute and putting effort into this work. 👍 I can already see benefits of moving to GitHub Actions, the most obvious is more natural "Checks" tab.

localheinz · 2020-08-03T14:30:31Z

@nikolaposa

I am glad you like it! I'm prepared to follow up, as promised! 🤓

nikolaposa · 2020-08-03T14:37:36Z

@localheinz Thanks!

So what do you think should be the next steps? I suppose this was a PR with demonstrative purposes, do you think we should merge it anyway?

localheinz · 2020-08-03T14:38:32Z

@nikolaposa

👍 Let's merge it, and then I will follow up!

localheinz · 2020-08-03T14:47:01Z

Thank you, @nikolaposa!

Enhancement: Add a simple workflow to get started with GitHub Actions

7421db8

localheinz force-pushed the feature/hello branch from 63955b9 to 7421db8 Compare August 3, 2020 06:37

localheinz commented Aug 3, 2020

View reviewed changes

localheinz marked this pull request as ready for review August 3, 2020 07:08

nikolaposa self-assigned this Aug 3, 2020

nikolaposa self-requested a review August 3, 2020 08:11

nikolaposa approved these changes Aug 3, 2020

View reviewed changes

nikolaposa merged commit 2c67077 into nikolaposa:master Aug 3, 2020

localheinz deleted the feature/hello branch August 3, 2020 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancement: Add a simple workflow to get started with GitHub Actions #27

Enhancement: Add a simple workflow to get started with GitHub Actions #27

localheinz commented Aug 3, 2020 •

edited

Loading

localheinz left a comment •

edited

Loading

localheinz Aug 3, 2020

localheinz Aug 3, 2020

localheinz Aug 3, 2020 •

edited

Loading

localheinz Aug 3, 2020

localheinz Aug 3, 2020

localheinz Aug 3, 2020

localheinz Aug 3, 2020

localheinz Aug 3, 2020

localheinz Aug 3, 2020

localheinz Aug 3, 2020

nikolaposa left a comment

localheinz commented Aug 3, 2020

nikolaposa commented Aug 3, 2020

localheinz commented Aug 3, 2020

localheinz commented Aug 3, 2020

		@@ -0,0 +1,19 @@
		# https://docs.github.com/en/actions

		name: Build

Enhancement: Add a simple workflow to get started with GitHub Actions #27

Enhancement: Add a simple workflow to get started with GitHub Actions #27

Conversation

localheinz commented Aug 3, 2020 • edited Loading

localheinz left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

localheinz Aug 3, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nikolaposa left a comment

Choose a reason for hiding this comment

localheinz commented Aug 3, 2020

nikolaposa commented Aug 3, 2020

localheinz commented Aug 3, 2020

localheinz commented Aug 3, 2020

localheinz commented Aug 3, 2020 •

edited

Loading

localheinz left a comment •

edited

Loading

localheinz Aug 3, 2020 •

edited

Loading