Skip to content

Commit cc9f0f8

Browse files
committed
update doc & fix build
1 parent 27df6bc commit cc9f0f8

File tree

2 files changed

+83
-67
lines changed

2 files changed

+83
-67
lines changed

.github/workflows/build_and_release.yml

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -29,81 +29,81 @@ jobs:
2929
pnpm install
3030
pnpm run build
3131
32-
- name: Auto Generate Documentation
33-
run: |
34-
pnpm run doc
32+
# - name: Auto Generate Documentation
33+
# run: |
34+
# pnpm run doc
3535

36-
- name: Commit Documentation
37-
run: |
38-
git config --global user.email "github-actions[bot]@users.noreply.github.com"
39-
git config --global user.name "GitHub Actions"
40-
if [[ -n $(git status -s) ]]; then
41-
git add README.md
42-
git commit -m "Update Readme.md"
43-
else
44-
echo "No changes to commit"
45-
fi
36+
# - name: Commit Documentation
37+
# run: |
38+
# git config --global user.email "github-actions[bot]@users.noreply.github.com"
39+
# git config --global user.name "GitHub Actions"
40+
# if [[ -n $(git status -s) ]]; then
41+
# git add README.md
42+
# git commit -m "Update Readme.md"
43+
# else
44+
# echo "No changes to commit"
45+
# fi
4646

47-
- name: Push Documentation
48-
uses: ad-m/github-push-action@master
49-
with:
50-
github_token: ${{ secrets.GITHUB_TOKEN }}
51-
branch: main
47+
# - name: Push Documentation
48+
# uses: ad-m/github-push-action@master
49+
# with:
50+
# github_token: ${{ secrets.GITHUB_TOKEN }}
51+
# branch: main
5252

53-
- name: Get last modified file
54-
id: getfile
55-
run: |
56-
last_modified_file=$(ls -Art dist | tail -n 1)
57-
echo "Last modified file: $last_modified_file"
58-
echo "filename=$last_modified_file" >> $GITHUB_OUTPUT
59-
version=$(echo $last_modified_file | sed -n 's/.*-\([0-9.]*\).c3addon/\1/p')
60-
echo "Last modified file version: $version"
61-
echo "version=$version" >> $GITHUB_OUTPUT
53+
# - name: Get last modified file
54+
# id: getfile
55+
# run: |
56+
# last_modified_file=$(ls -Art dist | tail -n 1)
57+
# echo "Last modified file: $last_modified_file"
58+
# echo "filename=$last_modified_file" >> $GITHUB_OUTPUT
59+
# version=$(echo $last_modified_file | sed -n 's/.*-\([0-9.]*\).c3addon/\1/p')
60+
# echo "Last modified file version: $version"
61+
# echo "version=$version" >> $GITHUB_OUTPUT
6262

6363
- name: Release
6464
uses: softprops/action-gh-release@v2
6565
if: startsWith(github.ref, 'refs/tags/')
6666
with:
6767
files: dist/**/*
6868

69-
- name: Check if variables are set
70-
id: check
71-
run: |
72-
publish=true
73-
if [[ -z "${{ secrets.C3_AUTH_USER }}" ]]; then
74-
echo "C3 AUTH_USER is not set. skip publishing."
75-
publish=false
76-
fi
77-
if [[ -z "${{ secrets.C3_AUTH_PASSWORD }}" ]]; then
78-
echo "C3 AUTH_PASSWORD is not set. skip publishing."
79-
publish=false
80-
fi
81-
echo "publish=$publish" >> $GITHUB_OUTPUT
69+
# - name: Check if variables are set
70+
# id: check
71+
# run: |
72+
# publish=true
73+
# if [[ -z "${{ secrets.C3_AUTH_USER }}" ]]; then
74+
# echo "C3 AUTH_USER is not set. skip publishing."
75+
# publish=false
76+
# fi
77+
# if [[ -z "${{ secrets.C3_AUTH_PASSWORD }}" ]]; then
78+
# echo "C3 AUTH_PASSWORD is not set. skip publishing."
79+
# publish=false
80+
# fi
81+
# echo "publish=$publish" >> $GITHUB_OUTPUT
8282

83-
- name: Install publish dependencies
84-
if: steps.check.outputs.publish == 'true'
85-
run: |
86-
npm install -g c3addon
83+
# - name: Install publish dependencies
84+
# if: steps.check.outputs.publish == 'true'
85+
# run: |
86+
# npm install -g c3addon
8787

88-
- name: Get Addon Url
89-
if: steps.check.outputs.publish == 'true'
90-
id: url
91-
run: |
92-
url=$(grep -oP 'addonUrl:\s?"\K[^"]*' src/pluginConfig.js | cut -d '"' -f 1)
93-
echo "Addon Url: $url"
94-
if [[ -z "$url" ]]; then
95-
echo "Addon Url is not set. skip publishing."
96-
exit 1
97-
fi
98-
echo "url=$url" >> $GITHUB_OUTPUT
88+
# - name: Get Addon Url
89+
# if: steps.check.outputs.publish == 'true'
90+
# id: url
91+
# run: |
92+
# url=$(grep -oP 'addonUrl:\s?"\K[^"]*' src/pluginConfig.js | cut -d '"' -f 1)
93+
# echo "Addon Url: $url"
94+
# if [[ -z "$url" ]]; then
95+
# echo "Addon Url is not set. skip publishing."
96+
# exit 1
97+
# fi
98+
# echo "url=$url" >> $GITHUB_OUTPUT
9999

100-
- name: Publish to Construct 3
101-
if: steps.check.outputs.publish == 'true'
102-
run: |
103-
c3addon publish \
104-
--addonUrl '${{steps.url.outputs.url}}' \
105-
--authUser ${{ secrets.C3_AUTH_USER }} \
106-
--authPassword ${{ secrets.C3_AUTH_PASSWORD }} \
107-
--uploadFile dist/${{ steps.getfile.outputs.filename }} \
108-
--version ${{ steps.getfile.outputs.version }} \
109-
--releaseNotes 'Released via GitHub Actions'
100+
# - name: Publish to Construct 3
101+
# if: steps.check.outputs.publish == 'true'
102+
# run: |
103+
# c3addon publish \
104+
# --addonUrl '${{steps.url.outputs.url}}' \
105+
# --authUser ${{ secrets.C3_AUTH_USER }} \
106+
# --authPassword ${{ secrets.C3_AUTH_PASSWORD }} \
107+
# --uploadFile dist/${{ steps.getfile.outputs.filename }} \
108+
# --version ${{ steps.getfile.outputs.version }} \
109+
# --releaseNotes 'Released via GitHub Actions'

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The main files you may want to look at would be instance.js
5252
| Fetch file size | Fetch the size of the file. | Path *(string)* <br> |
5353
| Create folder | Creates the folder. | Path *(string)* <br> |
5454
| Delete file | Deletes the file. | Path *(string)* <br> |
55-
| List files | Load a list of files in a given folder. Use expressions after this action to get the count and file names | Path *(string)* <br> |
55+
| List files | Load a list of files in a given folder. Use expressions after this action to get the count and file names | Path *(string)* <br>Recursive *(boolean)* <br> |
5656
| Move file | Moves the file. | Source *(string)* <br>Destination *(string)* <br> |
5757
| Open browser | Opens the browser. | URL *(string)* <br> |
5858
| Read binary file | Reads a file into a Binary Data object. Triggers 'On binary file read' when completes. | Tag *(string)* <br>Path *(string)* <br>Destination *(object)* <br> |
@@ -111,7 +111,6 @@ The main files you may want to look at would be instance.js
111111
| ArgumentAt | Get the argument at the given index. | string | Index *(number)* <br> |
112112
| ArgumentCount | Get the number of arguments. | number | |
113113
| ChosenPath | Return the chosen path after a file dialog. | string | |
114-
| AppFolder | Return the folder of the current app. | string | |
115114
| AppFolderURL | Return the URL of the folder of the current app. | string | |
116115
| DroppedFile | Return the dropped file after a file drop. | string | |
117116
| FileError | Return the error message after a file operation fails. | string | |
@@ -123,6 +122,23 @@ The main files you may want to look at would be instance.js
123122
| ProjectFilesFolderURL | Return the URL of the folder of the project files. | string | |
124123
| ReadFile | Return the contents of the file. | string | |
125124
| UserFolder | Return the current User's folder | string | |
125+
| HomeFolder | Return the current Home folder | string | |
126+
| AppDataFolder | Return the current AppDataFolder folder | string | |
127+
| UserDataFolder | Return the current UserDataFolder folder | string | |
128+
| SessionDataFolder | Return the current SessionDataFolder folder | string | |
129+
| TempFolder | Return the current TempFolder folder | string | |
130+
| ExeFolder | Return the current ExeFolder folder | string | |
131+
| ModuleFolder | Return the current ModuleFolder folder | string | |
132+
| DesktopFolder | Return the current DesktopFolder folder | string | |
133+
| DocumentsFolder | Return the current DocumentsFolder folder | string | |
134+
| DownloadsFolder | Return the current DownloadsFolder folder | string | |
135+
| MusicFolder | Return the current MusicFolder folder | string | |
136+
| PicturesFolder | Return the current PicturesFolder folder | string | |
137+
| VideosFolder | Return the current VideosFolder folder | string | |
138+
| RecentFolder | Return the current RecentFolder folder | string | |
139+
| LogsFolder | Return the current LogsFolder folder | string | |
140+
| CrashDumpsFolder | Return the current CrashDumpsFolder folder | string | |
141+
| AppFolder | Return the folder of the current app. | string | |
126142
| WindowHeight | Return the height of the window. | number | |
127143
| WindowWidth | Return the width of the window. | number | |
128144
| WindowTitle | Return the title of the window. | string | |

0 commit comments

Comments
 (0)