Skip to content

repo sync#78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Octomerger merged 5 commits into from
Sep 29, 2020
Merged

repo sync #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
caaee7a
Update all files to use `{% data %}` (#15253)
JasonEtco Sep 29, 2020
e56b1b8
use latest repo-sync/github-sync (#15798)
zeke Sep 29, 2020
3c039a6
merge conflicts, merge conflicts, merge conflicts
jmarlena Sep 29, 2020
c9e42a6
Fix a small syntax bug (#15801)
JasonEtco Sep 29, 2020
4b7a985
Merge branch 'main' into repo-sync
zeke Sep 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 2 additions & 2 deletions .github/workflows/repo-sync.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,11 +24,11 @@ jobs:
uses: actions/checkout@v2

- name: Sync repo to branch
uses: repo-sync/github-sync@v2.1.0
uses: repo-sync/github-sync@v2
env:
GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
with:
source_repo: ${{ secrets.SOURCE_REPO }}
source_repo: ${{ secrets.SOURCE_REPO }} # https://${access_token}@github.com/github/the-other-repo.git
source_branch: main
destination_branch: repo-sync
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
Expand Down
42 changes: 21 additions & 21 deletions content/actions/creating-actions/about-actions.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
---
title: About actions
intro: 'Actions are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {{ site.data.variables.product.prodname_dotcom }} community.'
product: '{{ site.data.reusables.gated-features.actions }}'
intro: 'Actions are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% datavariables.product.prodname_dotcom %} community.'
product: '{% datareusables.gated-features.actions %}'
redirect_from:
- /articles/about-actions
- /github/automating-your-workflow-with-github-actions/about-actions
Expand All@@ -12,22 +12,22 @@ versions:
enterprise-server: '>=2.22'
---

{{ site.data.reusables.actions.enterprise-beta }}
{{ site.data.reusables.actions.enterprise-github-hosted-runners }}
{% datareusables.actions.enterprise-beta %}
{% datareusables.actions.enterprise-github-hosted-runners %}

### About actions

You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {{ site.data.variables.product.prodname_dotcom }}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.
You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% datavariables.product.prodname_dotcom %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.

{% if currentVersion == "free-pro-team@latest" %}
You can write your own actions to use in your workflow or share the actions you build with the {{ site.data.variables.product.prodname_dotcom }} community. To share actions you've built, your repository must be public.
You can write your own actions to use in your workflow or share the actions you build with the {% datavariables.product.prodname_dotcom %} community. To share actions you've built, your repository must be public.
{% endif %}

Actions can run directly on a machine or in a Docker container. You can define an action's inputs, outputs, and environment variables.

### Types of actions

You can build Docker container and JavaScript actions. Actions require a metadata file to define the inputs, outputs and main entrypoint for your action. The metadata filename must be either `action.yml` or `action.yaml`. For more information, see "[Metadata syntax for {{ site.data.variables.product.prodname_actions }}](/articles/metadata-syntax-for-github-actions)."
You can build Docker container and JavaScript actions. Actions require a metadata file to define the inputs, outputs and main entrypoint for your action. The metadata filename must be either `action.yml` or `action.yaml`. For more information, see "[Metadata syntax for {% datavariables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions)."

| Type | Operating system |
| ---- | ------------------- |
Expand All@@ -37,19 +37,19 @@ You can build Docker container and JavaScript actions. Actions require a metadat

#### Docker container actions

Docker containers package the environment with the {{ site.data.variables.product.prodname_actions }} code. This creates a more consistent and reliable unit of work because the consumer of the action does not need to worry about the tools or dependencies.
Docker containers package the environment with the {% datavariables.product.prodname_actions %} code. This creates a more consistent and reliable unit of work because the consumer of the action does not need to worry about the tools or dependencies.

A Docker container allows you to use specific versions of an operating system, dependencies, tools, and code. For actions that must run in a specific environment configuration, Docker is an ideal option because you can customize the operating system and tools. Because of the latency to build and retrieve the container, Docker container actions are slower than JavaScript actions.

Docker container actions can only execute on runners with a Linux operating system. {{ site.data.reusables.github-actions.self-hosted-runner-reqs-docker }}
Docker container actions can only execute on runners with a Linux operating system. {% datareusables.github-actions.self-hosted-runner-reqs-docker %}

#### JavaScript actions

JavaScript actions can run directly on a runner machine, and separate the action code from the environment used to run the code. Using a JavaScript action simplifies the action code and executes faster than a Docker container action.

{{ site.data.reusables.github-actions.pure-javascript }}
{% datareusables.github-actions.pure-javascript %}

If you're developing a Node.js project, the {{ site.data.variables.product.prodname_actions }} Toolkit provides packages that you can use in your project to speed up development. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository.
If you're developing a Node.js project, the {% datavariables.product.prodname_actions %} Toolkit provides packages that you can use in your project to speed up development. For more information, see the [actions/toolkit](https://github.com/actions/toolkit) repository.

#### Composite run steps actions

Expand All@@ -60,14 +60,14 @@ A _composite run steps_ action allows you to combine multiple workflow run steps
If you're developing an action for other people to use, we recommend keeping the action in its own repository instead of bundling it with other application code. This allows you to version, track, and release the action just like any other software.

{% if currentVersion == "free-pro-team@latest" %}
Storing an action in its own repository makes it easier for the {{ site.data.variables.product.prodname_dotcom }} community to discover the action, narrows the scope of the code base for developers fixing issues and extending the action, and decouples the action's versioning from the versioning of other application code.
Storing an action in its own repository makes it easier for the {% datavariables.product.prodname_dotcom %} community to discover the action, narrows the scope of the code base for developers fixing issues and extending the action, and decouples the action's versioning from the versioning of other application code.
{% endif %}

{% if currentVersion == "free-pro-team@latest" %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`.

### Compatibility with {{ site.data.variables.product.prodname_ghe_server }}
### Compatibility with {% datavariables.product.prodname_ghe_server %}

To ensure that your action is compatible with {{ site.data.variables.product.prodname_ghe_server }}, you should make sure that you do not use any hard-coded references to {{ site.data.variables.product.prodname_dotcom }} API URLs. You should instead use environment variables to refer to the {{ site.data.variables.product.prodname_dotcom }} API:
To ensure that your action is compatible with {% datavariables.product.prodname_ghe_server %}, you should make sure that you do not use any hard-coded references to {% datavariables.product.prodname_dotcom %} API URLs. You should instead use environment variables to refer to the {% datavariables.product.prodname_dotcom %} API:

- For the REST API, use the `GITHUB_API_URL` environment variable.
- For GraphQL, use the `GITHUB_GRAPHQL_URL` environment variable.
Expand All@@ -84,7 +84,7 @@ If you're developing an action for other people to use, we recommend using relea

Under this release management approach, users should not be referencing an action's `master` branch, as it's likely to contain the latest code and consequently might be unstable. Instead, you can recommend that your users specify a major version when using your action, and only direct them to a more specific version if they encounter issues.

To use a specific action version, users can configure their {{ site.data.variables.product.prodname_actions }} workflow to target a tag, a commit's SHA, or a branch named for a release.
To use a specific action version, users can configure their {% datavariables.product.prodname_actions %} workflow to target a tag, a commit's SHA, or a branch named for a release.

#### Using tags for release management

Expand DownExpand Up@@ -139,21 +139,21 @@ We recommend creating a README file to help people learn how to use your action.
- Environment variables the action uses
- An example of how to use your action in a workflow

### Comparing {{ site.data.variables.product.prodname_actions }} to {{ site.data.variables.product.prodname_github_apps}}
### Comparing {% datavariables.product.prodname_actions %} to {% datavariables.product.prodname_github_apps %}

{{ site.data.variables.product.prodname_marketplace }} offers tools to improve your workflow. Understanding the differences and the benefits of each tool will allow you to select the best tool for your job. For more information about building apps, see "[About apps](/apps/about-apps/)."
{% datavariables.product.prodname_marketplace %} offers tools to improve your workflow. Understanding the differences and the benefits of each tool will allow you to select the best tool for your job. For more information about building apps, see "[About apps](/apps/about-apps/)."

#### Strengths of GitHub Actions and GitHub Apps

While both {{ site.data.variables.product.prodname_actions }} and {{ site.data.variables.product.prodname_github_app }}s provide ways to build automation and workflow tools, they each have strengths that make them useful in different ways.
While both {% datavariables.product.prodname_actions %} and {% datavariables.product.prodname_github_app %}s provide ways to build automation and workflow tools, they each have strengths that make them useful in different ways.

{{ site.data.variables.product.prodname_github_apps }}:
{% datavariables.product.prodname_github_apps %}:
* Run persistently and can react to events quickly.
* Work great when persistent data is needed.
* Work best with API requests that aren't time consuming.
* Run on a server or compute infrastructure that you provide.

{{ site.data.variables.product.prodname_actions }}:
{% datavariables.product.prodname_actions %}:
* Provide automation that can perform continuous integration and continuous deployment.
* Can run directly on runner machines or in Docker containers.
* Can include access to a clone of your repository, enabling deployment and publishing tools, code formatters, and command line tools to access your code.
Expand All@@ -162,4 +162,4 @@ While both {{ site.data.variables.product.prodname_actions }} and {{ site.data.v

### Further reading

- "[Development tools for {{ site.data.variables.product.prodname_actions }}](/articles/development-tools-for-github-actions)"
- "[Development tools for {% datavariables.product.prodname_actions %}](/articles/development-tools-for-github-actions)"
10 changes: 5 additions & 5 deletions content/actions/creating-actions/creating-a-composite-run-steps-action.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
---
title: Creating a composite run steps action
intro: 'In this guide, you''ll learn how to build a composite run steps action.'
product: '{{ site.data.reusables.gated-features.actions }}'
product: '{% datareusables.gated-features.actions %}'
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
---

{{ site.data.reusables.actions.enterprise-beta }}
{{ site.data.reusables.actions.enterprise-github-hosted-runners }}
{% datareusables.actions.enterprise-beta %}
{% datareusables.actions.enterprise-github-hosted-runners %}

### Introduction

Expand All@@ -18,9 +18,9 @@ Once you complete this project, you should understand how to build your own comp

### Prerequisites

Before you begin, you'll create a {{ site.data.variables.product.product_name }} repository.
Before you begin, you'll create a {% datavariables.product.product_name %} repository.

1. Create a new public repository on {{ site.data.variables.product.product_location }}. You can choose any repository name, or use the following `hello-world-composite-run-steps-action` example. You can add these files after your project has been pushed to {{ site.data.variables.product.product_name }}. For more information, see "[Create a new repository](/articles/creating-a-new-repository)."
1. Create a new public repository on {% datavariables.product.product_location %}. You can choose any repository name, or use the following `hello-world-composite-run-steps-action` example. You can add these files after your project has been pushed to {% datavariables.product.product_name %}. For more information, see "[Create a new repository](/articles/creating-a-new-repository)."

1. Clone your repository to your computer. For more information, see "[Cloning a repository](/articles/cloning-a-repository)."

Expand Down
Loading