Skip to content

Commit 1d1a51b

Browse files
Martin MahnerMartin Mahner
authored andcommitted
Update action references from @main to @v1 for stable release
1 parent bccfc63 commit 1d1a51b

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626

2727
- name: Build and deploy documentation
2828
id: deployment
29-
uses: ./
29+
uses: bartTC/microdocs@v1
3030
with:
3131
files: |
3232
README.md

ACTION.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Deploy beautiful documentation to GitHub Pages with a single step.
44

5-
> **Note**: This action is currently in active development. Use `@main` to get the latest features. Once stable, versioned releases (`@v1`) will be available.
5+
> **Note**: This action is currently in active development. Use `@v1` to get the latest features. Once stable, versioned releases (`@v1`) will be available.
66
77
## Quick Start
88

@@ -31,7 +31,7 @@ jobs:
3131
- uses: actions/checkout@v4
3232

3333
- name: Build and deploy documentation
34-
uses: bartTC/microdocs@main
34+
uses: bartTC/microdocs@v1
3535
with:
3636
files: |
3737
README.md
@@ -73,7 +73,7 @@ Your documentation will be available at `https://<username>.github.io/<repositor
7373

7474
```yaml
7575
- name: Build and deploy documentation
76-
uses: bartTC/microdocs@main
76+
uses: bartTC/microdocs@v1
7777
with:
7878
files: |
7979
README.md
@@ -103,7 +103,7 @@ To just build the documentation without deploying:
103103

104104
```yaml
105105
- name: Build documentation
106-
uses: bartTC/microdocs@main
106+
uses: bartTC/microdocs@v1
107107
with:
108108
files: 'README.md CHANGELOG.md'
109109
title: 'My Project Documentation'
@@ -117,7 +117,7 @@ Use your own HTML template:
117117

118118
```yaml
119119
- name: Build and deploy documentation
120-
uses: bartTC/microdocs@main
120+
uses: bartTC/microdocs@v1
121121
with:
122122
files: |
123123
README.md
@@ -131,7 +131,7 @@ Override the automatic repository URL:
131131

132132
```yaml
133133
- name: Build and deploy documentation
134-
uses: bartTC/microdocs@main
134+
uses: bartTC/microdocs@v1
135135
with:
136136
files: 'README.md'
137137
repo-url: 'https://github.com/myorg/myrepo'
@@ -143,7 +143,7 @@ Change where the HTML file is generated:
143143

144144
```yaml
145145
- name: Build and deploy documentation
146-
uses: bartTC/microdocs@main
146+
uses: bartTC/microdocs@v1
147147
with:
148148
files: 'README.md CHANGELOG.md'
149149
output: 'public/docs.html'
@@ -155,7 +155,7 @@ Change the directory used for deployment artifacts:
155155

156156
```yaml
157157
- name: Build and deploy documentation
158-
uses: bartTC/microdocs@main
158+
uses: bartTC/microdocs@v1
159159
with:
160160
files: 'README.md'
161161
artifact-dir: '_site'
@@ -196,7 +196,7 @@ jobs:
196196
uses: actions/checkout@v4
197197
198198
- name: Build and deploy documentation
199-
uses: bartTC/microdocs@main
199+
uses: bartTC/microdocs@v1
200200
with:
201201
files: |
202202
README.md

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Automatically deploy your documentation to GitHub Pages:
9898

9999
```yaml
100100
- name: Build and deploy documentation
101-
uses: bartTC/microdocs@main
101+
uses: bartTC/microdocs@v1
102102
with:
103103
files: |
104104
README.md

0 commit comments

Comments
 (0)