agiledigital-labs / confluence-plugin-idea-search

Provides a blue print for idea capture, search, and display.

Confluence Plugin Idea Search

Provides a blue print for idea capture, search, and display.

Release

The latest released version can be downloaded from github.

Requirements

The plugin is built using the Atlassian SDK, for installation instructions see Atlassian documentation.

Adding to confluence

Either add the addon through the Atlassian Market place (link to come) or by directly installing the .jar file from one of the releases

Developing

1. Clone the repository
2. Install the Atlassian SDK
3. In the root directory run atlas-run to start the confluence server
4. Once Confluence has started you can access it via http://localhost:1990/confluence. Note you will need to change the baseUrl in the confluence settings otherwise you will have issues with the creation of resources

• To run without tests add this argument to the command -Dmaven.test.skip=true
• We suggest dumping logs to a file due to the large number of lines in the output. A command to do this would be rm -rf logs.log; atlas-run > logs.log

To run the hot reload, have the confluence server running. Run the command atlas-mvn package which will build the app. The server will see the change and hot load the new version into the app.

Developer tooling

The following tools are required/recommended to develop with this repository

• Atlassian sdk: https://developer.atlassian.com/server/framework/atlassian-sdk/
• Yarn: https://classic.yarnpkg.com/en/docs/install
• Prettier: https://prettier.io/docs/en/install.html
• Nvm: https://github.com/nvm-sh/nvm#installing-and-updating
• Plugin integration test fixture: https://developer.atlassian.com/server/framework/atlassian-sdk/create-test-data-and-a-test-fixture/

Integration test with test confluence instance

Integration testing data can be generated, modified and stored in a test instance. This makes creating integration test fixtures much quicker and easier and is fully integrated with Atlassian sdk.

Run integration tests by suppling test data path in the following command. Currently the data is stored in src/test/resources
atlas-integration-test -Dtest.integration.path=pathToTestData

To utilise current test fixture and modify test data:

1. To see and explore existing test instance, start in debug mode atlas-debug
2. Currently in the test instance, there is a test page with four technologies: "java", "js", "python", "ts"
3. Navigate around confluence and create test data by interacting with the test instance.
4. Close the server and clean existing instance atlas-clean
5. Start again in debug mode. You should now see your test data in the instance.

To create a new test fixture:

1. Run an instance and interact with confluence to create test data. atlas-run -DskipTests=true
2. Create a zip of the application home directory in target. atlas-create-home-zip
3. Copy the test resources to plugin home directory. cp target/confluence/generated-test-resources.zip PLUGIN_HOME/src/test/resources

Contributing

PR are welcomed

Commit message syntax

This repository is using semantic release, therefore the commit messages should follow the angular guidelines or another guide .

Branching strategy

Branches should be attached either to an issue in this repository, or a ticket on the jira,

A branch attached to an issue

Please name the branch type/issueNumber/description

where type is either;

• feat
• fix
• chore
• docs
• etc from the semvar naming strategy

For example: feat/issue3/add-idea-blueprint

A branch attached to a Jira ticket

Please name the branch type/ticketNumber/description

where type is either;

• feat
• fix
• chore
• docs
• etc from the semvar naming strategy

For example: feat/ADE-101/add-idea-blueprint

Branch Flow

Your Branch => develop => qa => master

Making a PR

Please do the following before creating a PR;

• have an issue or a jira ticket,
• write a descriptive PR title
• Add the @agiledigital-labs/atlassian-plugin team as a reviewer
• We will review and provide feedback as soon as we can, it is easier if you help us along

Supported versions

We are supporting versions from 7.6.2 onwards at this stage, if there are any issues please raise an issue on this repo

confluence-plugin-idea-search's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Version mismatch

The pom.xml version of 1.2.0 differs too much from last git tag version of 1.1.0.

Please edit the project entry in the pom.xml file to have a version number of no more than 1 patch version ahead of the git tag version of 1.1.0.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Use vars for some dependencies in pom

Should this version also be a variable like mapstruct above? (similarly with other hard-coded versions in this file) ⬆️

_Originally posted by @shouvSarker in #52 (comment)
dependencies

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Version mismatch

The pom.xml version of 1.0.2-SNAPSHOT differs too much from last git tag version of undefined.

Please edit the project entry in the pom.xml file to have a version number of no more than 1 patch version ahead of the git tag version of undefined.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Unicode on the page removes it from the search results

If a character like → is on the page, the page will not show in the index pages search results.

Increase idea limit on table

The idea limit is capped at 20 and needs to be increased to incorporate all our ideas onto the table

confluence-plugin-idea-search/src/main/java/au/com/agiledigital/idea_search/macros/IndexTable.java

Line 170 in d54eafa

new SubsetResultFilter(20));

Page parenting process makes any index created page a child

When creating a new page from the create button on an index page, it creates a page according to that blueprint type. E.g. technical article index page button creates a technical article page. Upon saving this page, the page is nested under the Fedex ideas page

Convert model builder methods to use mapStruct

It seems like an excellent use of map struct

Can we do this with something like mapStruct?

Originally posted by @shouvSarker in #52 (comment)

Should we start using environment variables for folders in CI

Should we start using environment variables now? I think ./frontend-react has been referenced in this file four times.

Originally posted by @shouvSarker in #52 (comment)