bit-badger/feed-reader-central
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 10 Activity

Address user config overwriting on upgrade #18

New Issue
Closed
opened 2024-04-27 23:00:10 +00:00 by danieljsummers · 1 comment
danieljsummers commented 2024-04-27 23:00:10 +00:00
Owner
Copy Link

As currently designed, user-config.php is a file that users are free to modify. However, with it in the source repository under that name, upgrades will copy the repository version over a possibly-modified version.

To fix this, rename user-config.php to user-config.dist.php, and update the installation instructions to include renaming this file. Future upgrades will continue to overwrite the dist version (allowing users to diff the two after upgrading, to see if there are any new configuration items), but will leave the user's configuration alone.

As currently designed, `user-config.php` is a file that users are free to modify. However, with it in the source repository under that name, upgrades will copy the repository version over a possibly-modified version. To fix this, rename `user-config.php` to `user-config.dist.php`, and update the installation instructions to include renaming this file. Future upgrades will continue to overwrite the `dist` version (allowing users to diff the two after upgrading, to see if there are any new configuration items), but will leave the user's configuration alone.
danieljsummers added this to the alpha4 milestone 2024-04-27 23:00:20 +00:00
danieljsummers self-assigned this 2024-04-27 23:00:28 +00:00
danieljsummers commented 2024-04-27 23:10:17 +00:00
Author
Owner
Copy Link

This is complete

This is complete
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels   
Kind/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

No Label
Kind/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No Milestone
alpha4
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
danieljsummers
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: bit-badger/feed-reader-central#18
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?