{"id":19221040,"url":"https://github.com/midnighter/nf-slack","last_synced_at":"2025-02-23T09:26:37.778Z","repository":{"id":138077700,"uuid":"561106822","full_name":"Midnighter/nf-slack","owner":"Midnighter","description":"Create notification messages from nextflow using incoming webhooks for Slack.","archived":false,"fork":false,"pushed_at":"2022-11-07T19:57:49.000Z","size":84,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-04T20:15:10.027Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Midnighter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-03T00:47:44.000Z","updated_at":"2022-11-03T00:48:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"32603c40-45a8-4082-bc7c-890c3e4d3c67","html_url":"https://github.com/Midnighter/nf-slack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Midnighter%2Fnf-slack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Midnighter%2Fnf-slack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Midnighter%2Fnf-slack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Midnighter%2Fnf-slack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Midnighter","download_url":"https://codeload.github.com/Midnighter/nf-slack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240295212,"owners_count":19778854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T14:39:46.619Z","updated_at":"2025-02-23T09:26:37.405Z","avatar_url":"https://github.com/Midnighter.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Slack Notification Nextflow Plugin\n\n_Create notification messages from nextflow using incoming webhooks for Slack._\n\nTODO: This is the beginning of your Slack Notification Nextflow plugin project. Please, briefly describe its purpose here.\n\n## Plugin Assets\n\n| File                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |\n| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `settings.gradle`                                                              | Gradle project settings.                                                                                                                                                                                                                                                                                                                                                                                                                                                       |\n| `plugins/nf-slack`                                       | The plugin implementation base directory.                                                                                                                                                                                                                                                                                                                                                                                                                                      |\n| `plugins/nf-slack/build.gradle`                          | Plugin Gradle build file. Project dependencies should be added here.                                                                                                                                                                                                                                                                                                                                                                                                           |\n| `plugins/nf-slack/src/resources/META-INF/MANIFEST.MF`    | Manifest file that defines the plugin attributes, e.g., name, version, and so on. The attribute `Plugin-Class` declares the plugin main class. This class should extend the base class `nextflow.plugin.BasePlugin` as shown by `nextflow.slack.SlackPlugin` in `plugins/nf-slack/src/main/nextflow/slack/SlackPlugin.groovy`. |\n| `plugins/nf-slack/src/resources/META-INF/extensions.idx` | This file declares one or more extension classes provided by the plugin. Each line should contain the fully qualified name of a Java class that implements the `org.pf4j.ExtensionPoint` interface (or a sub-interface).                                                                                                                                                                                                                                                       |\n| `plugins/nf-slack/src/main`                              | The plugin implementation sources.                                                                                                                                                                                                                                                                                                                                                                                                                                             |\n| `plugins/nf-slack/src/test`                              | The plugin unit tests.                                                                                                                                                                                                                                                                                                                                                                                                                                                         |\n\n## Extension\n\n`ExtensionPoint` is the basic interface used by nextflow-core to integrate plugins. It's only a basic interface and serves as a starting point for more specialized extensions.\n\nAmong others, nextflow-core integrates the following sub extenions:\n\n-   `TraceObserverFactory` to provide a list of `TraceObserver`s\n-   `ChannelExtensionPoint` to enrich the `Channel` object with custom methods\n\nIt is up to you to decide which of these your plugin defines.\n\n## Unit testing\n\nRun the following command in the project root directory:\n\n```bash\nmake test\n```\n\n## Testing and debugging\n\nThere are several tests you can use under `plugins/nf-hello/src/test` folder. You can also test yours DSL (see `HelloDslTest.groovy`) !!!\n\nOnce tested you can try your plugin in a nextflow sesion:\n\n1. Generate required artifacts with `make build-plugins`\n2. Copy `build/plugins/nf-slack-0.1.0a1.zip` to `$HOME/.nextflow/plugins`\n3. Create a pipeline with your plugin and see it in action\n\n## Publish\n\nThe project should be hosted in a GitHub repository whose name should match the name of the plugin, e.g., https://github.com/Midnighter/nf-slack.\n\nFollow these steps to package, upload, and publish the plugin:\n\n1. Create a file named `gradle.properties` in the project root containing the following attributes (this file should not be committed to git):\n\n    - `github_organization`: the GitHub organisation where the plugin repository is hosted.\n    - `github_username`: The GitHub username granting access to the plugin repository.\n    - `github_access_token`: The GitHub access token required to upload and commit changes to the plugin repository.\n    - `github_commit_email`: The email address associated with your GitHub account.\n\n2. Use the following command to package and create a release for your plugin on GitHub:\n\n    ```bash\n    make upload-plugins\n    ```\n\n3. Create a pull request against [nextflow-io/plugins](https://github.com/nextflow-io/plugins/blob/main/plugins.json) to make the plugin accessible to Nextflow.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidnighter%2Fnf-slack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmidnighter%2Fnf-slack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidnighter%2Fnf-slack/lists"}