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.

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

NEW Use a single-source-of-truth to determine version mapping #107

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
/htdocs
/data
/.vagrant/
/.phpunit.result.cache
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,10 @@ generated through [Doctum](https://github.com/code-lts/doctum#readme).
* Run the `makedoc.sh` script as a cronjob, usually a nightly run at 3am is fine:
`0 3 * * * /sites/api/www/makedoc.sh`

### Add a New Version
### Add a new major ersion

* Copy a version section block in `conf/doctum.json` and ensure you use the appropriate value for `versionmap` - you may need to add more mappings to `versionmap` if the current mappings don't fit all modules for the new major version (e.g. if splitting some functionality off into its own module)
* Add a new version in the `'versions'` key in `conf/doctum.json`
* Make sure https://github.com/silverstripe/supported-modules has been updated with a new branch for the new major version with correct branch mapping
* Run `makedoc.sh` and confirm the generation runs through properly
* Make a commit of the updated `conf/doctum.json`
* Update the redirections in `.htaccess` to the stable version number (if releasing a new stable major version)
Expand All @@ -53,8 +54,8 @@ to the used API generator URL layout.

Parameters:

* `q`: (required) Class name, method name (`<class>::<method>()` or <class>-><method>()`),
as well as property name ((`<class>::$<property>` or <class>-><property>`).
* `q`: (required) Class name, method name (`<class>::<method>()` or `<class>-><method>()`),
as well as property name ((`<class>::$<property>` or `<class>-><property>`).
* `version`: (optional) Version of the targeted module. Should map to a folder name. Default is defined in `src/Lookup.php`.
* `module`: (optional) Module name. Should map to a folder name. Defaults to framework.

Expand All @@ -68,4 +69,4 @@ Examples:

## Contributing

While SilverStripe self-hosts this project, community contributions to the code are very welcome :) Please check out our [guide to contributing code](https://github.com/silverstripe/silverstripe-framework/blob/4.0/docs/en/05_Contributing/01_Code.md) on silverstripe.org
While SilverStripe self-hosts this project, community contributions to the code are very welcome :) Please check out our [guide to contributing code](https://docs.silverstripe.org/en/contributing/code/) on silverstripe.org
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
}
},
"require-dev": {
"phpunit/phpunit": "^7",
"phpunit/phpunit": "^8.5",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needed to use $this->expectWarning() in a test.

"squizlabs/php_codesniffer": "^3"
}
}
Loading