Skip to content

Commit b234aee

Browse files
committed
Updated linkes to other repos in README
1 parent 17f89af commit b234aee

File tree

4 files changed

+119
-11
lines changed

4 files changed

+119
-11
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ insert_final_newline = false
1111
# bash/zsh cannot parse script files with crlf line endings
1212
end_of_line = lf
1313

14-
[*.{yaml,yml}]
14+
[*.{yaml,yml,md}]
1515
indent_style = space
1616
indent_size = 2

.gitignore

Lines changed: 109 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,110 @@
1-
/node_modules
2-
# Dist files should not be committed by developers, will be built and committed by a workflow:
3-
/dist
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# TypeScript v1 declaration files
45+
typings/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
78+
# Next.js build output
79+
.next
80+
81+
# Nuxt.js build / generate output
82+
.nuxt
83+
dist
84+
85+
# Gatsby files
86+
.cache/
87+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
88+
# https://nextjs.org/blog/next-9-1#public-directory-support
89+
# public
90+
91+
# vuepress build output
92+
.vuepress/dist
93+
94+
# Serverless directories
95+
.serverless/
96+
97+
# FuseBox cache
98+
.fusebox/
99+
100+
# DynamoDB Local files
101+
.dynamodb/
102+
103+
# TernJS port file
104+
.tern-port
105+
106+
# Finder view state file
107+
.DS_Store
108+
109+
# Source map files are used for local debugging only
4110
**/*.map

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,7 @@
2323
"typescript.implementationsCodeLens.enabled": true,
2424
"typescript.preferences.includePackageJsonAutoImports": "on",
2525
"typescript.preferences.quoteStyle": "double",
26+
"yaml.schemas": {
27+
"https://json.schemastore.org/github-workflow.json": ".github/workflows/build.yml"
28+
},
2629
}

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,18 @@ The following configuration steps can be performed by this action:
2525

2626
Running this action at the start of your workflow job allows you to run any OrgFlow commands with minimal hassle in subsequent steps of your job, without having to provide any of the above configuration again.
2727

28+
See also:
29+
30+
- Our [`demo`](https://github.com/OrgFlow-Actions/demo) template repository that contains a set of basic sample workflows that show how to use OrgFlow in GitHub Actions
31+
- Our [`result2comment`](https://github.com/OrgFlow-Actions/result2comment) action which allows you to post the results of an OrgFlow command as a comment on a GitHub issue or pull request
32+
2833
## Supported platforms
2934

3035
This action works on:
3136

3237
- GitHub-hosted runners and self-hosted runners
3338
- Ubuntu, macOS and Windows
34-
- The `orgflow/cli` Docker image, or your own Docker image
39+
- With or without a container (also works with the `orgflow/cli` Docker image)
3540

3641
Git version 2.25 or later is required. When running on GitHub-hosted runners or on our Docker images, all requirements are met.
3742

@@ -207,12 +212,6 @@ For most public Git services such as GitHub, Azure Repos, BitBucket etc., you wo
207212

208213
**Remember to use secrets to store your Git credentials!**
209214

210-
## Other actions
211-
212-
We also maintain several other useful actions, which complement this one to provide deep first-class integration of OrgFlow into GitHub Actions:
213-
214-
- [`comment-env-flowout-result`](https://github.com/OrgFlow-Actions/comment-env-flowout-result)
215-
216215
## Versioning
217216

218217
All of our `orgflow-actions/*` actions are semantically versioned. Breaking changes will cause a major version bump.

0 commit comments

Comments
 (0)