The application provides a centralized dashboard for viewing issues list from multiple repositories in a single place.
·
Report Bug
·
Request Feature
The project was created in response to a common problem faced by teams using BitBucket to manage their code repositories: how to keep track of issues across multiple repositories.
Until recently, there was a centralized dashboard page at https://bitbucket.org/dashboard/issues, which provided a consolidated view of all issues assigned to the user. This dashboard page was a valuable tool for users, as it allowed them to quickly catch up on old issues, prioritize tasks, and ensure that nothing fell through the cracks. However, the dashboard page was phased out.
Recognizing the need for a centralized and user-friendly solution to manage issues across multiple repositories in BitBucket, this project was created.
The application provides an easy-to-use interface for viewing issues in a BitBucket workspace from multiple repositories in one place, making it easier for teams to collaborate and stay organized. This is especially useful for teams that work on multiple projects or use multiple repositories to manage their code.
In addition to providing a consolidated view of issues, the application allows users to filter issues across multiple repositories based on specific criteria, such as issue type, priority, and assignee. This can save time and effort, as users do not need to manually search through each repository to find relevant issues.
The project is in the MVP stage.
Follow the instructions below to run local copy of service with Docker.
To run the app with Docker, you will need to have Docker installed on your system and have a basic understanding of Docker containers and how to manage them using Docker Compose or other tools.
- Create an application password for your BitBucket account with permissions to read your account, repositories, and issues.
- Copy the default config.example.yml file and rename it to
config.yml. Update the values in theconfig.ymlfile with your BitBucket username, password, and other settings as needed. Alternatively, you can create a newconfig.ymlfile from scratch, using the format described in the Configuration section. - Run the Docker container with the
capcom6/bitbucket-issuesimage, and expose port 8000 to access the web interface. You can do this by running the following command:docker run -d -p 8000:8000 -v $(pwd)/config.yml:/app/config.yml capcom6/bitbucket-issues:latest
This command will start the Docker container and mount your custom config.yml file as a volume in the container. The container will listen on port 8000, which you can access in your web browser by navigating to http://localhost:8000 or http://<docker-machine-ip>:8000, depending on your Docker setup.
Here's an overview of how the application works:
- The application reads the configuration settings from the
config.ymlfile, which specifies the BitBucket access settings, issue loading settings, and cache storage settings. - The application connects to the BitBucket Cloud API using the specified login and app password, and loads issues from the specified repositories and filters.
- The application caches the loaded issues in memory or Redis, depending on the specified cache storage settings and the TTL (Time-To-Live) value.
- The application starts a web server and serves a user interface that allows users to view the loaded issues. Users can filter and sort issues based on various criteria, such as issue type, priority, and assignee.
- When a user selects an issue, the application provides a direct link to the issue in BitBucket, allowing the user to view and modify the issue as needed.
- The application automatically refreshes the cached issues based on the TTL value specified in the
config.ymlfile. This ensures that the cached issues are up-to-date and accurate, without overloading the BitBucket API with frequent requests.
The application is configured using the config.yml file, which specifies the BitBucket access settings, issue loading settings, and cache storage settings. However, it is also possible to provide these configuration values using environment variables like BITBUCKET__LOGIN with double underscores between parent-child sections.
bitbucket: # BitBucket access settings
login: login # User login for the BitBucket account.
password: password # App password for the BitBucket account, with read access to account info, repositories, and issues.
owner: owner # The owner of the repositories to load issues from.
issues: # Issues loading settings
repositoriesFilter: # A filter for the repositories to load issues from, using BitBucket's JQL syntax.
issuesFilter: (state = "new" OR state = "open" OR state = "on hold") AND (priority = "major" OR priority = "critical" OR priority = "blocker") # A filter for the issues to load, using BitBucket's JQL syntax.
storage: # Cache storage settings
dsn: memory:// # The DSN (Data Source Name) for the cache storage. Supports memory:// and redis:// schemes.
ttl: PT6H # The TTL (Time-To-Live) for cached items, specified in ISO 8601 duration format.The application does not include any built-in authorization or authentication mechanism. To enhance security, it is recommended to use an external service or tool, such as Nginx, to provide basic authentication and restrict access to the application. Alternatively, deploying the application in a private network can provide an additional layer of security and help prevent unauthorized access from external sources.
- When you first launch the application, it may take some time to load issues from BitBucket, depending on the number of repositories and issues. During this loading period, the UI may display 0 issues. Please be patient and allow the application time to load the issues. Subsequent loads should be faster, as issues are cached for improved performance.
- The user interface of the application, as well as some parts of the documentation, were created by ChatGPT, a large language model trained by OpenAI. While ChatGPT's responses are typically accurate and informative, please note that they are generated by a machine learning model and may not always be perfect.
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the Apache-2.0 license. See LICENSE.txt for more information.
Project Link: https://github.com/capcom6/bitbucket-issues
- The BitBucket development team, for creating and maintaining a powerful and flexible platform for managing code repositories, and for providing a comprehensive and well-documented API.
- Redis Labs, for providing a powerful and scalable in-memory database solution, which is used to cache issues and improve performance.
- The developers of the "bitbucket-python" library (https://github.com/GearPlug/bitbucket-python), which provides a convenient and easy-to-use interface for accessing the BitBucket API from Python.
- The "FastAPI" web framework (https://fastapi.tiangolo.com/), which is used to build the backend API.
- OpenAI, for developing and providing access to ChatGPT, a large language model used to generate some of the UI and documentation content.