You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
24
24
-[Escaping single quotes](#escaping-single-quotes)
25
25
-[Autogenerated mini TOCs](#autogenerated-mini-tocs)
26
26
-[Versioning](#versioning)
27
+
-[Free-pro-team vs. GitHub.com versioning](#free-pro-team-vs.-github.com-versioning)
27
28
-[Filenames](#filenames)
28
29
-[Whitespace control](#whitespace-control)
29
30
-[Links and image paths](#links-and-image-paths)
@@ -213,6 +214,12 @@ A content file can have **two** types of versioning:
213
214
* Liquid statements in content (**optional**)
214
215
* Conditionally render content depending on the current version being viewed. See [contributing/liquid-helpers](../contributing/liquid-helpers.md) for more info. Note Liquid conditionals can also appear in `data` and `include` files.
215
216
217
+
### Free-pro-team vs. GitHub.com versioning
218
+
219
+
As of early 2021, the `free-pro-team@latest` version is **only** supported in content files (in both frontmatter and Liquid versioning) and throughout the docs site backend. It is **not** user facing. A helper function called `lib/remove-fpt-from-path.js` removes the version from URLs. Users now select `GitHub.com` in the Article Versions dropdown instead of `Free, Pro, Team`.
220
+
221
+
The convenience function allows us to continue supporting a consistent versioning structure under-the-hood while not displaying plan information to users that may be potentially confusing.
222
+
216
223
## Filenames
217
224
218
225
When adding a new article, make sure the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) version of the title you use in the article's [`title`](#title) frontmatter. This can get tricky when a title has punctuation (such as "GitHub's Billing Plans"). A test will flag any discrepancies between title and filename. To override this requirement for a given article, you can add [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename) frontmatter.
@@ -224,7 +231,7 @@ When using Liquid conditionals in lists or tables, you can use [whitespace contr
224
231
Just add a hyphen on either the left, right, or both sides to indicate that there should be no newline on that side. For example, this statement removes a newline on the left side:
225
232
226
233
```
227
-
{%- if page.version == 'dotcom' %}
234
+
{%- if currentVersion == 'free-pro-team@latest' %}
228
235
```
229
236
230
237
These characters are especially important in [index pages](#index-pages) comprised of list items.
@@ -238,9 +245,9 @@ For example, if you include the following link in a content file:
238
245
```
239
246
/github/writing-on-github/creating-a-saved-reply
240
247
```
241
-
When viewed on GitHub.com docs, the link gets rendered with the language code and version:
248
+
When viewed on GitHub.com docs, the link gets rendered with the language code:
Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, write the link using HTML and add a class of `dotcom-only`. For example:
264
271
265
-
```
272
+
```html
266
273
<a href="/github/site-policy/github-terms-of-service" class="dotcom-only">GitHub's Terms of Service</a>
Copy file name to clipboardExpand all lines: content/actions/creating-actions/dockerfile-support-for-github-actions.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,20 +48,21 @@ The Docker `ENTRYPOINT` instruction has a _shell_ form and _exec_ form. The Dock
48
48
49
49
If you configure your container to use the _exec_ form of the `ENTRYPOINT` instruction, the `args` configured in the action's metadata file won't run in a command shell. If the action's `args` contain an environment variable, the variable will not be substituted. For example, using the following _exec_ format will not print the value stored in `$GITHUB_SHA`, but will instead print `"$GITHUB_SHA"`.
50
50
51
-
```
51
+
```dockerfile
52
52
ENTRYPOINT ["echo $GITHUB_SHA"]
53
53
```
54
54
55
55
If you want variable substitution, then either use the _shell_ form or execute a shell directly. For example, using the following _exec_ format, you can execute a shell to print the value stored in the `GITHUB_SHA` environment variable.
56
56
57
-
```
57
+
```dockerfile
58
58
ENTRYPOINT ["sh", "-c", "echo $GITHUB_SHA"]
59
-
````
59
+
```
60
60
61
61
To supply `args` defined in the action's metadata file to a Docker container that uses the _exec_ form in the `ENTRYPOINT`, we recommend creating a shell script called `entrypoint.sh` that you call from the `ENTRYPOINT` instruction:
Copy file name to clipboardExpand all lines: content/actions/guides/caching-dependencies-to-speed-up-workflows.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,14 +124,14 @@ A cache key can include any of the contexts, functions, literals, and operators
124
124
Using expressions to create a `key` allows you to automatically create a new cache when dependencies have changed. For example, you can create a `key` using an expression that calculates the hash of an npm `package-lock.json` file.
125
125
126
126
{% raw %}
127
-
```
127
+
```yaml
128
128
npm-${{ hashFiles('package-lock.json') }}
129
129
```
130
130
{% endraw %}
131
131
132
132
{% data variables.product.prodname_dotcom %} evaluates the expression `hash "package-lock.json"` to derive the final `key`.
133
133
134
-
```
134
+
```yaml
135
135
npm-d5ea0750
136
136
```
137
137
@@ -144,7 +144,7 @@ You can provide a list of restore keys to use when there is a cache miss on `key
144
144
#### Example using multiple restore keys
145
145
146
146
{% raw %}
147
-
```
147
+
```yaml
148
148
restore-keys: |
149
149
npm-foobar-${{ hashFiles('package-lock.json') }}
150
150
npm-foobar-
@@ -155,7 +155,7 @@ restore-keys: |
155
155
The runner evaluates the expressions, which resolve to these `restore-keys`:
0 commit comments