Add build provider #277
Add build provider #277
Conversation
starbelly
force-pushed
the
add-build-provider
branch
7 times, most recently
from
b395dfe to
959e460
Compare
src/rebar3_hex_build.erl
Outdated
| %% <li>`links' - A map where the key is a link name and the value is the link URL. Optional but highly recommended. | ||
| %% <li> `files' - A list of files and directories to include in the package. Defaults to standard project directories, | ||
| %% so you usually don't need to set this property.</li> | ||
| %% <li> `include_files' - A list of paths containing files you wish to include in a release. </li> |
There was a problem hiding this comment.
I feel like these should be called include_paths and exclude_paths and we could also perhaps support exclude_files. They both work on paths right now. Thoughts?
There was a problem hiding this comment.
the _paths variants are clearer, but it's not a super significant difference either way, especially if this ends up using glob or wildcard patterns (though that's exclude_patterns, which has also been renamed). The "confusion" is already common (e.g. filelib supports is_file|dir|regular already).
I'd tend to still lower the updating friction for the plugin by keeping this compatible with the stuff that was already in the .app.src file though, to make upgrading the plugin as easy as possible. The 7.0 update will likely have people update their licenses, so there should at least be an obvious way to know that you're done fixing what broke rather than suddenly having older options not work (if any, I mostly recall just using files).
Either way I'm fine with the direction we're going.
src/rebar3_hex_build.erl
Outdated
| %% <h2> Command line options </h2> | ||
| %% | ||
| %% <ul> | ||
| %% <li>`--repo' - Specify the repository to use in the task. This option is required when |
There was a problem hiding this comment.
I don't like that we support this on this provider, but we currently support being able to configure a doc provider on a per repo basis.
src/rebar3_hex_build.erl
Outdated
| %% <li>`links' - A map where the key is a link name and the value is the link URL. Optional but highly recommended. | ||
| %% <li> `files' - A list of files and directories to include in the package. Defaults to standard project directories, | ||
| %% so you usually don't need to set this property.</li> | ||
| %% <li> `include_files' - A list of paths containing files you wish to include in a release. </li> |
There was a problem hiding this comment.
the _paths variants are clearer, but it's not a super significant difference either way, especially if this ends up using glob or wildcard patterns (though that's exclude_patterns, which has also been renamed). The "confusion" is already common (e.g. filelib supports is_file|dir|regular already).
I'd tend to still lower the updating friction for the plugin by keeping this compatible with the stuff that was already in the .app.src file though, to make upgrading the plugin as easy as possible. The 7.0 update will likely have people update their licenses, so there should at least be an obvious way to know that you're done fixing what broke rather than suddenly having older options not work (if any, I mostly recall just using files).
Either way I'm fine with the direction we're going.
src/rebar3_hex_build.erl
Outdated
| %% <ul> | ||
| %% <li>`--repo' - Specify the repository to use in the task. This option is required when | ||
| %% you have multiple repositories configured, including organizations. The argument must | ||
| %% be a fully qualified repository name (e.g, `hexpm', `hexpm:my_org', `my_own_hexpm'). |
There was a problem hiding this comment.
PRobably worth adding defaults to expm
src/rebar3_hex_build.erl
Outdated
| %% contains all needed files before publishing. See --output below for setting the output path. | ||
| %% </li> | ||
| %% <li> `-o', `--output' - Sets output path. When used with --unpack it means the directory | ||
| %% (Default: <app>-<version>). Otherwise, it specifies tarball path (Default: <app>-<version>.tar)</li> |
There was a problem hiding this comment.
We would usually tend to default the output to somewhere in _build/<profile>/ so these don't get to bypass .gitignore on build artifacts.
There was a problem hiding this comment.
Good point. Will change.
I'll add support for |
- add support for building packages and docs tarballs - align the keys for packages and docs in regards to `version` vs `vsn` - rename attribute for exclude regular expressions from `exclude_regexps` to `exclude_patterns`
|
yeah just supporting newer options without breaking the old stuff is fine, if it's not too much extra complexity. Keep a comment about the reason for it so whoever is still maintaining this in the future has a good contextual clue of the intent behind it. |
starbelly
force-pushed
the
add-build-provider
branch
from
959e460 to
d960d3a
Compare
starbelly
force-pushed
the
add-build-provider
branch
from
b82699c to
de3161e
Compare
|
Note : I made one more change, in line with the others around name changes (i.e., continue to support exclude_regexps). |
This is ready but depends on #272 being merged first.
Closes #233