@makefully/adaptfully 5.0.6 → 5.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +46 -3
- package/lib/node/publish-credentials.js +2 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project are documented in this file.
|
|
4
4
|
|
|
5
|
+
## 5.0.7 — 2026-10-07
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- Gitignore patterns for `assets/meta/deployments/**/s3.json` and `**/showfully.json`.
|
|
10
|
+
- Docs for web deploy via SFTP (atomic `cleanRemote`), AWS S3, and Showfully folder (credential shapes consumed by Wrapfully).
|
|
11
|
+
|
|
5
12
|
## 5.0.6 — 2026-10-07
|
|
6
13
|
|
|
7
14
|
### Changed
|
package/README.md
CHANGED
|
@@ -437,11 +437,17 @@ mygame/
|
|
|
437
437
|
│ └── sftp.json
|
|
438
438
|
├── web-prod/
|
|
439
439
|
│ └── sftp.json
|
|
440
|
+
├── web-s3-prod/
|
|
441
|
+
│ ├── manifest.json # { "type": "s3" }
|
|
442
|
+
│ └── s3.json
|
|
443
|
+
├── web-showfully/
|
|
444
|
+
│ ├── manifest.json # { "type": "showfully" }
|
|
445
|
+
│ └── showfully.json
|
|
440
446
|
└── steam/ # default deployment for the `steam` platform
|
|
441
447
|
└── steam.json
|
|
442
448
|
```
|
|
443
449
|
|
|
444
|
-
The selected deployment's folder is shipped as `meta/publish/` in the zip, so per-platform credential file names (`build.json`, `sftp.json`, `steam.json`, `apple.json`, `google.json`, `ms.json`, `android/`, `ms/`) live inside `assets/meta/deployments/<key>/`.
|
|
450
|
+
The selected deployment's folder is shipped as `meta/publish/` in the zip, so per-platform credential file names (`build.json`, `sftp.json`, `s3.json`, `showfully.json`, `steam.json`, `apple.json`, `google.json`, `ms.json`, `android/`, `ms/`) live inside `assets/meta/deployments/<key>/`.
|
|
445
451
|
|
|
446
452
|
Icons (`icon-foreground.png`, `icon-background.png`) are required for mobile, desktop, and Steam builds. If either file is missing from `assets/meta/`, Adaptfully **warns** and ships packaged placeholder icons for that build so Wrapfully can still run.
|
|
447
453
|
|
|
@@ -718,7 +724,9 @@ Release `win` builds can be signed with `assets/meta/deployments/<deployment>/ms
|
|
|
718
724
|
|
|
719
725
|
#### Web (`web` / `webapp`)
|
|
720
726
|
|
|
721
|
-
`adaptfully deploy web` prebuilds and POSTs to the Wrapfully **`webapp`** builder (same conduit as Steam).
|
|
727
|
+
`adaptfully deploy web` prebuilds and POSTs to the Wrapfully **`webapp`** builder (same conduit as Steam). Each web deployment folder under `assets/meta/deployments/<key>/` is zipped as `meta/publish/` for Wrapfully. Set `manifest.json` `"type"` to `sftp`, `s3`, or `showfully` (or rely on the credential filename). The inner settings key stays the builder name (`webapp`).
|
|
728
|
+
|
|
729
|
+
**SFTP** — `sftp.json`:
|
|
722
730
|
|
|
723
731
|
```json
|
|
724
732
|
{
|
|
@@ -736,7 +744,42 @@ Release `win` builds can be signed with `assets/meta/deployments/<deployment>/ms
|
|
|
736
744
|
}
|
|
737
745
|
```
|
|
738
746
|
|
|
739
|
-
|
|
747
|
+
`path` is the remote site root or a longer subfolder path. With `uploadMode: "direct"` and `cleanRemote: true`, Wrapfully uploads to `[path]-temp`, then deletes the live directory and renames temp → `path` (atomic replace). `cleanRemote` is ignored for `versioned` uploads.
|
|
748
|
+
|
|
749
|
+
**AWS S3** — `s3.json` + `manifest.json` `{ "type": "s3" }`:
|
|
750
|
+
|
|
751
|
+
```json
|
|
752
|
+
{
|
|
753
|
+
"webapp": {
|
|
754
|
+
"region": "us-east-1",
|
|
755
|
+
"bucket": "my-games-cdn",
|
|
756
|
+
"prefix": "",
|
|
757
|
+
"uploadMode": "direct",
|
|
758
|
+
"cleanRemote": false,
|
|
759
|
+
"accessKeyId": "(iam access key)",
|
|
760
|
+
"secretAccessKey": "(iam secret)"
|
|
761
|
+
}
|
|
762
|
+
}
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
`prefix: ""` deploys to the bucket root; `"games/mygame"` deploys under that key prefix. `cleanRemote: true` uses an atomic `prefix-temp` swap (refuses empty prefix unless `allowBucketRootWipe: true`).
|
|
766
|
+
|
|
767
|
+
**Showfully folder** — `showfully.json` + `manifest.json` `{ "type": "showfully" }`:
|
|
768
|
+
|
|
769
|
+
```json
|
|
770
|
+
{
|
|
771
|
+
"webapp": {
|
|
772
|
+
"server": "https://make.makefullystudios.com/",
|
|
773
|
+
"folder": "MyGame",
|
|
774
|
+
"path": "",
|
|
775
|
+
"accessToken": "sfpat_…"
|
|
776
|
+
}
|
|
777
|
+
}
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
`folder` is a top-level Showfully folder name. `path: ""` writes at that folder’s root; `"web"` (or nested) prefixes zip entries under a subfolder. `accessToken` is required (Wrapfully workers cannot reuse the Yap submit PAT).
|
|
781
|
+
|
|
782
|
+
See [Wrapfully README](https://github.com/Makefully-Studios/wrapfully-client) for `uploadMode`, `serviceWorker`, `metaWeb`, and deployer details.
|
|
740
783
|
|
|
741
784
|
#### Windows (`win`, `win-dev`, `uwp`)
|
|
742
785
|
|
|
@@ -6,6 +6,8 @@ import { stdin as input, stdout as output } from 'node:process';
|
|
|
6
6
|
/** Patterns that should never be committed from deployment credential folders. */
|
|
7
7
|
export const PUBLISH_CREDENTIAL_GITIGNORE_PATTERNS = [
|
|
8
8
|
'assets/meta/deployments/**/sftp.json',
|
|
9
|
+
'assets/meta/deployments/**/s3.json',
|
|
10
|
+
'assets/meta/deployments/**/showfully.json',
|
|
9
11
|
'assets/meta/deployments/**/steam.json',
|
|
10
12
|
'assets/meta/deployments/**/build.json',
|
|
11
13
|
'assets/meta/deployments/**/google.json',
|