Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ghost 3.0 gscan changes #144

Closed
13 of 14 tasks
ErisDS opened this issue Aug 13, 2018 · 1 comment · Fixed by #257
Closed
13 of 14 tasks

Ghost 3.0 gscan changes #144

ErisDS opened this issue Aug 13, 2018 · 1 comment · Fixed by #257
Assignees
@naz
Labels
enhancement

Comments

@ErisDS
Copy link
Member

ErisDS commented Aug 13, 2018 •
edited by naz
Loading

Running v3 rules (--canary flag feature)

This flag is needed to allow us testing gscan v3 rules before Ghost v3 is released.

The file with canary definitions can be aliased to --v3 flag, so as we near new version release, we could make it possible to do gscan --canary or gscan --v3, so that theme developers can have their themes ready against any known changes way ahead of the release.

canary spec will exist perpetually (similar to /canary/ API in Ghost) out of which stable v3/v4 etc. specs will be branched once they reach stability.

Todos:

Post v3 release:

  • prepare v3 (out of canary rules) set of rules becoming a default (latest) version on a v3 branch (will release 3.0.0 out of this branch)
  • Update details for {{subscribe_form}} deprecation

NOTE: the initial issue was more like a note and can be checked for reference in history.
@naz
Copy link
Contributor

naz commented Apr 3, 2019

First rules to be added as fatal for v3.0 can be based on #181 and #174.

@aileen aileen assigned naz and unassigned aileen May 8, 2019
@naz naz mentioned this issue Sep 2, 2019
Merged
6 tasks
naz added a commit that referenced this issue Sep 3, 2019
@naz
✨ Canary flag for future version checks (#248)
f0aa341 
refs #144

- Added 'canary' version support to `checkVersion` check options to checker
- Added `--canary`/`-c` flag support to CLI, allowing to run checks against canary (future v3) rules
- Added fixtures and test modification for canary checks
- Added checks for deprecations. These are same as for latest version as canary doesn't introduce any new rules yet
- Added canary tests for package.json suite
- Added canary tests for css classes suite
naz added a commit to naz/gscan that referenced this issue Sep 3, 2019
@naz
✨ Added "Canary"
d0a1de6 
 option to check against in web interface

refs TryGhost#144
This was referenced Sep 3, 2019
Merged
Merged
naz added a commit to naz/gscan that referenced this issue Sep 4, 2019
@naz
✨ Added "canary" option to check against in web interface
fb20567 
refs TryGhost#144
naz added a commit that referenced this issue Sep 4, 2019
@naz
✨ Added "canary" option to check against in web interface (#249)
ce9ee0f 
refs #144
naz added a commit that referenced this issue Sep 6, 2019
@naz
✨ Version specific checks --v2 and --v3 (#250)
2cd82cd 
refs #144

- Renamed specs into a versioned format
- latest -> v2
- canary -> v3
- latest & canary are now acting as aliases to versions instead of "defining" them

- Added test coverage for all possible version variations accepted by checker
- The variations are as follows:
- {checkVersion: 'v1'}
- {checkVersion: 'v2'} aliased to {checkVersion: 'latest'}
- {checkVersion: 'v3'} aliased to {checkVersion: 'canary'}

- Added ability to check agains v2 and v3 specs through CLI
- This adds support for -2 / --v2 and -3 / --v3 parameters in the CLI
- Updated readme with new parameters
- Added debug call to see which version is actually being checked
@naz naz mentioned this issue Sep 6, 2019
Merged
naz added a commit that referenced this issue Sep 6, 2019
@naz
Renamed test fixture folders to v2 & v3
05992d0 
refs #144

- Renamed latest/canary folders to correspond to their spec versions instead of alliases
naz added a commit that referenced this issue Sep 6, 2019
@naz
Changed latest/canary naming usages in test suites
7600139 
refs #144

- Misc. changes for alliases used in naming for test suites instead of specific versions
naz added a commit that referenced this issue Sep 13, 2019
@naz
✨ Added v4 spec support as "canary" and set "latest" to v3 spec (#251)
b2b5059 
refs #144

- Added empty v4 specs
- Allowed running v4 checks through CLI
- Changed aliasing for canary/latest specs
  - v3 -> latest
  - v4 -> canary
- Updated web interface to include v4 checks and set a new default version
- Updated readme
- Updated test suite names to reflect better what they do
- Added a comment explaining why some suites don't have versioned suites (separate describe groups for v2, v3 etc.)
@naz naz mentioned this issue Sep 13, 2019
Merged
naz added a commit that referenced this issue Sep 13, 2019
@naz
Reversed canary rule structure (#254)
da51c0a 
refs #144

- This structure based on the similar convention as in Ghost core where 'canary' is a perpetual version out of which stable 'v2', 'v3'... versions are branched out once they reach a stable version
- Modified test suits to use 'canary' instead of 'v3'
- Made 'v3' rules to be aliased to 'canary'  and not the other way around
- Updated web UI to work with canary version
@naz naz mentioned this issue Sep 16, 2019
Merged
naz added a commit to naz/gscan that referenced this issue Sep 16, 2019
@naz
Updated wording for get users helper
e9d2a6b 
refs TryGhost#144

- Updates wording for {{#get "userss"}} helper which will no longer return any data
naz added a commit to naz/gscan that referenced this issue Sep 16, 2019
@naz
Updated wording for get users helper
5239a62 
refs TryGhost#144

- Updates wording for {{#get "userss"}} helper which will no longer return any data
@naz naz mentioned this issue Sep 16, 2019
Merged
naz added a commit that referenced this issue Sep 16, 2019
@naz
✨ Added pakcage.json "ghost-api" warning rule in canary (#255)
db57986 
refs #144

- Added 'canary' set of rules to package.json checker
- Added S010-PJ-GHOST-API rule to canary spec
naz added a commit that referenced this issue Sep 16, 2019
@naz
💄Updated wording for {{#get "users"}} helper (#256)
a7f3d83 
refs #144

- Updates wording for {{#get "userss"}} helper which will no longer return any data
@naz naz mentioned this issue Sep 17, 2019
Merged
naz added a commit to naz/gscan that referenced this issue Sep 17, 2019
@naz
✨ Added pakcage.json "ghost-api === v1" error rule in canary set
48ae056 
refs TryGhost#144

- Added new rule to detect old ghost-api in engines
@naz naz mentioned this issue Sep 17, 2019
Merged
2 tasks
naz added a commit that referenced this issue Sep 17, 2019
@naz
✨ Added rule in canary set for ghost-api=v0.1 detection (#258)
701467c 
refs #144

- Added new "error" level rule to detect old ghost-api (v0.1) in engines.ghost-api property used in package.json
naz added a commit to naz/gscan that referenced this issue Sep 19, 2019
@naz
💡️Corrected error.statusCode rule to deprecate error.code instead
ecabbe0 
refs TryGhost#144
refs TryGhost#137

- The original {{statusCode}} deprecation (TryGhost#137) was a mistake and what was meant to be deprecated is {{code}} (ref. https://github.com/TryGhost/Ghost/pull/9144/files#diff-6b41d6f0ef148f7d202931a87d5c4130R85)
- `statusCode` was meant to be used everywhere similarly to this change - TryGhost/Ghost@02199c6
@naz naz mentioned this issue Sep 19, 2019
Merged
naz added a commit to TryGhost/Ghost that referenced this issue Sep 19, 2019
@naz
Marked code property for removal in Ghost 4.0
cc8f9bc 
refs TryGhost/gscan#144
refs TryGhost/gscan#259

- The property hasn't been marked correctly in Ghsot 2.0 so will be able to go away the earliest in Ghost 4.0
naz added a commit that referenced this issue Sep 19, 2019
@naz
💡️Corrected error.statusCode rule to deprecate error.code instead (#259)
2ebd9fe 
refs #144
refs #137

- Overridden GS001-DEPR-ESC v2 rule in canary set
- The original {{statusCode}} deprecation (#137) was a mistake and what was meant to be deprecated is {{code}} (ref. https://github.com/TryGhost/Ghost/pull/9144/files#diff-6b41d6f0ef148f7d202931a87d5c4130R85)
- `statusCode` was meant to be used everywhere similarly to this change - TryGhost/Ghost@02199c6
naz added a commit to naz/gscan that referenced this issue Sep 25, 2019
@naz
✨ Added subscribe_form deprecation warning
9fa6689 
refs TryGhost#144

- Subscribers as a feature is going away in Ghost 3.0
naz added a commit to naz/gscan that referenced this issue Oct 7, 2019
@naz
🔥 Removed statusCode rule in v2 set
dedc0fa 
refs TryGhost#144

- This rule was not meant to be there in the first place and might cause confusion for people who check if their v3 theme is running with Ghost v2 properly
naz added a commit to naz/gscan that referenced this issue Oct 7, 2019
@naz
🔥 Removed statusCode rule in v2 set
e42b9f8 
refs TryGhost#144

- This rule was not meant to be there in the first place and might cause confusion for people who check if their v3 theme is running with Ghost v2 properly
@naz naz mentioned this issue Oct 7, 2019
Merged
naz added a commit to naz/gscan that referenced this issue Oct 7, 2019
@naz
🔥 Removed statusCode rule in v2 set
59fc804 
refs TryGhost#144

- This rule was not meant to be there in the first place and might cause confusion for people who check if their v3 theme is running with Ghost v2 properly
naz added a commit that referenced this issue Oct 8, 2019
@naz
🔥 Removed {{statusCode}} rule in v2 set (#263)
43c727e 
refs #144

- This rule was not meant to be there in the first place and might cause confusion for people who check if their v3 theme is running with Ghost v2 properly
@naz naz closed this as completed in #257 Oct 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@naz naz

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

V3 To be merged with Ghost 3.0 TryGhost/gscan
3 participants
@ErisDS @naz @aileen