Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Monitor
Service Desk
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Documentation
Docs
Developer Documentation
Commits
f26ba896
Commit
f26ba896
authored
6 years ago
by
totten
Browse files
Options
Downloads
Patches
Plain Diff
civix.md - Add upgrade section
parent
a409177a
No related branches found
Branches containing commit
No related tags found
1 merge request
!516
Add pointers to civix upgrade instructions
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/extensions/civix.md
+10
-0
10 additions, 0 deletions
docs/extensions/civix.md
with
10 additions
and
0 deletions
docs/extensions/civix.md
+
10
−
0
View file @
f26ba896
...
...
@@ -489,3 +489,13 @@ The skeletal test class does not do anything useful. For more details on how to
To run the tests see the instructions
[
for running PHPUnit tests
](
/testing/phpunit.md#running-tests
)
.
## Upgrade civix {:#upgrade}
What happens when a new version of
`civix`
comes out? Your extension should continue to work as-is -- after all,
`civix`
is just a code-generator.
However, if you generate an extension with one version of
`civix`
(e.g. v16.03), and if you upgrade (e.g. v18.03), and if you run a new generator,
then you
*could*
encounter problems. This is because generators and templates evolve over time -- in particular, new templates may rely on new
helpers and stubs in
`<mymodule>.php`
and
`<mymodule>.civix.php`
.
Fortunately, these changes are rare; they tend to have limited impact; and there's documentation for them. From time-to-time, you should check
[
UPGRADE.md
](
https://github.com/totten/civix/blob/master/UPGRADE.md
)
for suggestions on updating your code to match the current templates.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment