Feature Request: Provide hook for executing custom task after build has been completed
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 511
- Forks
- 83
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 55
Description
Is your feature request related to a problem? Please describe.
As of now (Specification Version 2.2) there is no proper way to execute a custom task after the build itself has succeeded.
It is only possible to execute a custom task after other individual build tasks (latest possible point of time is afterTask: generateVersionInfo)
At this point of time the build itself has not been completed, so the dist folder has not been written yet.
But a e.g. task for deployment requires the final dist folder for zipping and uploading.
The @sap/ux-ui5-tooling custom task deploy-to-abap is an example for the lack of this feature.
The custom task can only run afterTask: generateVersionInfo (documentation even states afterTask: replaceVersion, which is way to early btw).
As a workaround the task only considers virtual build resources for deployment.
But only the dist folder contains the final physical resources and one should not rely on any virtual resources.
Some custom tasks might even copy (physical) files from project shims to the dist folder during the build process (e.g. ui5-task-copy-shim-resources).
Describe the solution you'd like
An example config could look like this to register a custom task after the build has completed:
builder:
customTasks:
- name: deploy-to-abap
afterTask: buildCompleted
configuration:
some: configurations
or
tooling:
lifecycleTasks:
- name: deploy-to-abap
after: buildCompleted
configuration:
some: configurations
Describe alternatives you've considered
A workaround for now is to use taskUtil.registerCleanupTask, because this is the only point of time where one can be sure that the build has completed.
module.exports = async ({ taskUtil, options }) => {
const { configuration = {} } = options
const { target, credentials, app } = configuration
const { url, client } = target
const { username, password } = credentials
const { transport } = app
// https://sap.github.io/ui5-tooling/api/module-@ui5_builder.tasks.TaskUtil.html
taskUtil.registerCleanupTask(async () => {
await abapDeploy({
sourceFolder: path.join(process.cwd(), 'dist'),
targetSystem: url,
client,
username,
password,
abapTransport: transport
})
await cleanup([
'.ABAPDeployResources',
'abap-deploy.log',
'dist.zip'
])
})
}
Additional context
This should be a feature that many projects should require when it comes to delivering for production using the UI5 Tooling.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the custom task lifecycle configuration described in the issue and the TaskUtil.registerCleanupTask API used by the workaround. Trace how cleanup tasks are scheduled relative to writing the dist folder. Done means a documented lifecycle hook can run after the build completes and access the final physical dist resources.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- build-system, cli, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100