Publishing issues
Keep your users informed about what's been released by publishing issues to your changelog. Learn how to move issues from your roadmap to your changelog effectively.
Understanding issue publishing
What is issue publishing?
Issue publishing moves completed issues from your roadmap to your changelog, showing users:
- What was released: Features and improvements delivered
- When it was released: Release dates and timelines
- How it helps: Benefits and impact for users
- What's next: Upcoming features and improvements
Publishing benefits
- User communication: Keep users informed about progress
- Transparency: Show you're delivering on promises
- Community engagement: Celebrate completed work
- Expectation management: Set realistic release timelines
Automatic publishing
Status-based publishing
- Go to Project Settings → Statuses
- For each status, toggle "Publish to changelog"
- Issues automatically publish when they reach that status
- Configure release dates and details
Recommended statuses for publishing
- Implemented: Completed and released features
- Released: Features available to users
- Deployed: Features live in production
- Completed: Finished development work
Publishing configuration
- Release date: Set when feature was released
- Release notes: Add detailed release information
- Featured status: Highlight important releases
- Tags: Categorize releases by type
Manual publishing
Selecting issues for publishing
- Go to your project dashboard
- Navigate to the Issues section
- Select issues you want to publish
- Click "Publish to Changelog"
Publishing process
- Select issues: Choose issues to publish
- Set release date: Specify when features were released
- Add details: Include release notes and descriptions
- Configure settings: Set featured status and tags
- Publish: Make changes live
Publishing options
- Individual publishing: Publish one issue at a time
- Bulk publishing: Publish multiple issues together
- Scheduled publishing: Publish at specific times
- Draft publishing: Save as draft before publishing
Release management
Release planning
- Release cycles: Plan regular release schedules
- Feature grouping: Group related features together
- Priority ordering: Publish important features first
- Timeline coordination: Coordinate with development cycles
Release notes
- Feature descriptions: Explain what was added
- Bug fixes: List resolved issues
- Improvements: Highlight enhancements
- Breaking changes: Note any breaking changes
Release communication
- User notifications: Notify users of new releases
- Email announcements: Send release emails
- Social media: Share releases on social platforms
- Documentation updates: Update user documentation
Changelog customization
Entry formatting
- Title format: Consistent title structure
- Description format: Standardized descriptions
- Date format: Consistent date formatting
- Tag format: Standardized tag usage
Visual customization
- Featured entries: Highlight important releases
- Category colors: Use colors for different types
- Icon usage: Add icons for visual appeal
- Layout options: Choose different layouts
Content guidelines
- Tone consistency: Maintain consistent tone
- Technical accuracy: Ensure accurate information
- User focus: Write for end users
- Clarity: Use clear, understandable language
Best practices
Publishing strategy
- Regular publishing: Publish updates regularly
- Meaningful releases: Only publish significant changes
- User value: Focus on user benefits
- Transparency: Be honest about what's included
Content quality
- Accurate information: Ensure information is correct
- Complete details: Provide sufficient detail
- User-friendly: Write for your audience
- Consistent format: Maintain consistent formatting
Timing considerations
- Release timing: Publish when features are ready
- User expectations: Meet user expectations
- Development cycles: Align with development cycles
- Communication timing: Coordinate with other communications
Advanced features
Release automation
- CI/CD integration: Automate publishing from CI/CD
- Git integration: Publish based on Git commits
- Deployment hooks: Publish on deployment
- Scheduled releases: Plan future releases
Release analytics
- Publishing metrics: Track publishing frequency
- User engagement: Monitor changelog views
- Release impact: Measure release impact
- User feedback: Collect release feedback
Integration options
- Email marketing: Integrate with email tools
- Social media: Share releases on social platforms
- Project management: Connect to project tools
- Analytics: Track release performance
Troubleshooting
Common issues
- Publishing failures: Issues not publishing correctly
- Date problems: Incorrect release dates
- Content issues: Problems with release content
- Permission errors: Access control problems
Resolution steps
- Check status: Verify issue status
- Review settings: Check publishing settings
- Test publishing: Try manual publishing
- Contact support: Get help if needed
Next steps
- [Roadmap setup] - Configure roadmap display
- [Manual entries] - Create custom changelog posts